Skip to content

modapi_login.md

Latest commit

 

History

History
65 lines (49 loc) · 3.44 KB

modapi_login.md

File metadata and controls

65 lines (49 loc) · 3.44 KB
Raw

modapi login

Sign in with your Moderation API account

Synopsis

Sign in with your Moderation API account in the browser.

The CLI gets an organization key for the organization you pick and keeps it in the OS keychain (or a 0600 file when there is no keychain). modapi init uses it to create projects. Revoke it on the dashboard's API keys page.

On a machine without a browser, such as over SSH, use --device: you confirm a code on another device. In CI, skip login and set MODAPI_ORGANIZATION_KEY.

This is not the same as "modapi auth login", which stores a project key you already have.

modapi login [flags]

Examples

  modapi login
  modapi login --device

Options

      --device          Sign in by confirming a code on another device (for SSH and machines without a browser)
  -h, --help            help for login
      --no-browser      Print the sign-in URL instead of opening the browser
      --wait duration   How long to wait for you to finish signing in (default 5m0s)

Options inherited from parent commands

      --agent-mode             Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDECODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
      --color string           Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
  -d, --debug                  Log request and response diagnostics to stderr
      --dry-run                Preview API requests without sending them (no network, no OS keychain). Human preview on stderr; with -o json or --jq, one JSON object per request on stdout. Local mutation commands (auth login, auth logout and configure) make no request: they skip prompts and writes and report a no-op (stderr, or one JSON object on stdout in the machine form)
  -H, --header stringArray     Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
      --include-headers        Include HTTP response headers in the output
      --interactive            Prompt for missing inputs and open guided configure/auth forms (forms fall back to line prompts on stdin off-TTY) (default true)
  -q, --jq string              Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
      --no-interactive         Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
      --no-keyring             Never read or write the OS keychain; store secrets in the config file instead (env: MODAPI_NO_KEYRING)
  -o, --output-format string   Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
      --raw-output             Write --jq string results as raw text instead of JSON strings (like jq -r); non-string results stay JSON
      --secret-key string      HTTP Bearer
      --server string          Select a server by index (for indexed servers) or name (for named servers)
      --server-url string      Override the default server URL
      --timeout string         HTTP request timeout (e.g., 30s, 5m, 100ms)
      --usage                  Print the CLI Usage schema in KDL format

SEE ALSO

  • modapi - Moderation API: Moderate text, images, video and audio in real time, manage authors, review queues and actions, and receive webhooks

Exit codes: 0 ok · 1 runtime · 2 usage · 3 authentication/authorization