CLI

Connect a project to Arcjet with the CLI: sign in, pick a team and site, and write ARCJET_KEY. Use when bootstrapping Arcjet, listing requests or guards, or managing remote rules from a terminal.

arcjet 21b39fb 1.4 KB Updated

File contents

Arcjet CLI

Preferred way to get a real ARCJET_KEY before writing Arcjet code. Do not leave the key as a TODO.

npx -y @arcjet/cli@latest auth status
# if not signed in:
npx -y @arcjet/cli@latest auth login

npx -y @arcjet/cli@latest teams list --output json --fields id,name
npx -y @arcjet/cli@latest sites list --team-id <team_id> --output json --fields id,name
npx -y @arcjet/cli@latest sites get-key --site-id <site_id> --output json --fields key

Write key to the project's env file as ARCJET_KEY=ajkey_.... Match existing env-file conventions and .gitignore. Never hardcode the key.

Frequent use: npm install -g @arcjet/cli, brew install arcjet/tap/arcjet, or curl -sSfL https://arcjet.com/cli/install.sh | bash.

--output json and --fields keep agent context small. Confirm with the user before write or delete operations (--confirm).

Investigate: requests list / guards list / requests explain / guards explain / briefing. Remote rules: rules create (DRY_RUN) → analyze dry-run-impactrules promote.

If the CLI cannot run, load @arcjet/skills#mcp or send the user to https://console.arcjet.com.

arcjet/arcjet-js/tree/main/arcjet-skills/skills/cli commit 21b39fbae6

Frequently asked questions

npx skillmds@latest add arcjet/cli