Skip to content

modapi_link.md

Latest commit

 

History

History
70 lines (54 loc) · 3.83 KB

modapi_link.md

File metadata and controls

70 lines (54 loc) · 3.83 KB
Raw

modapi link

Connect this directory to an existing Moderation API project

Synopsis

Connect the project in the current directory to a Moderation API project you already have.

link makes a new secret key for the project, named after this computer and directory, and writes it (MODAPI_SECRET_KEY) and the webhook signing secret (MODAPI_WEBHOOK_SECRET) to the project's env file. The project's other keys keep working, so you can revoke this one on its own.

Name the project by ID or by name. Without one, link lists your projects to pick from. It needs an organization key: sign in with "modapi login", or set MODAPI_ORGANIZATION_KEY.

When the env file already has a key for another project, link asks before replacing it (use --force in scripts).

modapi link [project] [flags]

Examples

  modapi link
  modapi link "Acme Marketplace"
  modapi link proj_123 --env-file .env.local

Options

      --dir string                The project directory (default ".")
      --env-file string           Env file to write the secrets to (default: .env.local for Next.js, else .env)
      --force                     Replace a key for another project without asking
  -h, --help                      help for link
      --organization-key string   Organization key to use. Prefer the MODAPI_ORGANIZATION_KEY env var: a flag value stays in shell history (default: the key from modapi login)

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