Skip to content

index.md

Latest commit

 

History

History
70 lines (49 loc) · 1.71 KB

index.md

File metadata and controls

70 lines (49 loc) · 1.71 KB

appcircle login

Log in to obtain your access token.

appcircle login [options]

Subcommands

personal-access-key - Login with Personal Access Key

appcircle login personal-access-key --secret <secret>

Options

      --secret <secret>   Personal Access Key

api-key - Login with API Key

appcircle login api-key --name <name> --secret <secret> [--organization-id <id>]

Options

      --name <name>            API Key name
      --secret <secret>        API Key secret
      --organization-id <id>   Organization ID (optional)

Examples

# Login with Personal Access Key
appcircle login personal-access-key --secret "my-secret"

# Login with API Key
appcircle login api-key --name "my-api-key" --secret "my-secret"

# Login with API Key and specific organization
appcircle login api-key --name "my-api-key" --secret "my-secret" --organization-id "org-123"

Authentication Behavior

  • If you're already logged in and try to login again, you'll see a "You are already logged in" message
  • You must logout first before logging in with different credentials
  • Use appcircle logout to clear your current authentication

Interactive Mode

In interactive mode (appcircle -i), authentication options are grouped under "Authentication (Login/Logout)" menu:

  • Select "Authentication (Login/Logout)" from the main menu
  • Choose "Login" or "Logout" from the submenu
    • When choosing Login, you can authenticate using:
      • API Key
      • Personal Access Key
  • Use "⬅ Back" to navigate between menus

Options inherited from parent commands

      --help   Show help for command