ArmorClaudeConfiguration

Configuration

Browser sign-in, plugin settings, environment variables, and plugin management

Configuration

These guides document ArmorClaude 0.2.22. The quick start installs armorclaude@armoriq and the armoriq CLI. Its backend is production.

Authentication

Sign in through your browser:

armoriq login --product armorclaude
armoriq whoami

If the CLI was not installed globally:

npx @armoriq/sdk login --product armorclaude

ArmorClaude reads the saved armorclaude profile for the selected backend from ~/.armoriq/credentials.json. It does not read an API key from plugin settings or ARMORIQ_API_KEY. A login for another product or backend does not replace this profile.

Without a usable login, ArmorClaude starts in monitor mode and shows the login command. Intent requirements are disabled until you connect. Local policy rules still apply. Skipping the installer's sign-in prompt keeps the plugin installed so you can connect later.

Plugin Settings

Open /plugin, select the installed ArmorClaude plugin, and choose Configure.

SettingTypeEffect
default_templatestringStages a template on first run for your confirmation. It does not apply it automatically
disable_observabilitybooleanStops execution traces and token usage sync
disable_usage_syncbooleanStops token usage sync while leaving traces enabled

There is no api_key field. Sign in with armoriq login --product armorclaude instead.

Environment Variables

VariableDefaultEffect
ARMORIQ_ENVproductionLeave unset for production. development, dev, local, or test selects a local stack
CLAUDE_PLUGIN_DATASet by Claude CodeTakes precedence over ARMORCLAUDE_DATA_DIR
ARMORCLAUDE_DATA_DIR~/.claude/armorclaude outside Claude CodeFallback data directory when CLAUDE_PLUGIN_DATA is absent
ARMORCLAUDE_POLICY_FILE<dataDir>/policy.jsonOverrides the policy file
ARMORCLAUDE_RUNTIME_FILE<dataDir>/runtime.jsonOverrides the runtime file
ARMORIQ_OBSERVABILITY_DISABLEDfalseFallback for the disable_observability plugin setting
ARMORIQ_USAGE_SYNC_DISABLEDfalseFallback for the disable_usage_sync plugin setting
ARMORCLAUDE_ENFORCEMENT_ENGINElocalSelects the enforcement engine
ARMORCLAUDE_OPA_PDP_URLunsetPDP URL when using OPA
ARMORCLAUDE_DEBUGfalsePrints plugin diagnostics to stderr
ARMORIQ_ORG_MODEunsetenforce makes this machine block whatever the workspace mode says

The telemetry plugin settings take precedence over their environment fallbacks. Boolean values accept true, 1, yes, y, and on.

Behavior variables such as ARMORCLAUDE_MODE, ARMORCLAUDE_INTENT_REQUIRED, ARMORCLAUDE_VALIDITY_SECONDS, and CSRG_VERIFY_ENABLED are not read. Your login and the workspace mode decide whether calls are blocked. Token validity is set to 3600 seconds in the plugin configuration.

Local development

ARMORIQ_ENV=local, ARMORIQ_LOCAL_MOCK=true, or the presence of ~/.armoriq/local-mode enables local mock mode. In that mode, ARMORIQ_BACKEND_URL and ARMORIQ_CSRG_URL can override the local endpoints, which otherwise use http://localhost:8000. Keep mock mode disabled when connecting to a real ArmorIQ account.

Data Directory

Claude Code supplies the plugin's data directory: ~/.claude/plugins/data/armorclaude-armoriq/.

The directory holds policy and runtime state, audit records, telemetry queues, and worker logs. Paths shown as <dataDir> in these guides refer to it.

Update or Disable the Plugin

claude plugin list
claude plugin disable armorclaude@armoriq
claude plugin enable armorclaude@armoriq
claude plugin marketplace update armoriq
claude plugin update armorclaude@armoriq

Restart Claude Code after an update.

Uninstall

claude plugin uninstall armorclaude@armoriq

Removing the plugin does not remove its data. If you also want to discard its policy, runtime state, and telemetry queues, close Claude Code first, then remove its directories:

rm -rf ~/.claude/plugins/cache/armoriq/armorclaude
rm -rf ~/.claude/plugins/data/armorclaude-armoriq

Keep ~/.armoriq/credentials.json and the rest of ~/.armoriq. Other ArmorIQ products share that directory. Do not remove the armoriq marketplace or the global SDK CLI while another plugin still uses them.

On this page