arch-cli

arch-cli is the ARCH-Insight command-line client. It includes commands for working with the product API, importing architecture data, managing the developer platform, and using the secrets vault.

Install

python -m pip install arch-insight-cli

The installed command is arch (also available as arch-cli). Python 3.9 or newer is required.

Authenticate

Product commands such as tasks and fact sheets require a GoTrue user access token. Set it as ARCH_ACCESS_TOKEN or pass it with --token:

export ARCH_ACCESS_TOKEN='your-user-access-token'

Developer-platform commands also accept the platform token through ARCH_TOKEN. Set ARCH_API_URL to use a self-hosted deployment; the default is https://arch-insight.com.

Tasks

arch task create "Review database costs" \
  --description "Check the quarterly forecast" \
  --project-id 12 --board-id 4 --priority high \
  --assignee "Alex Example" --due-date 2026-12-01

arch task list --project-id 12

The create command prints the created task as JSON. Repeat --assignee to assign more than one person.

Fact sheets

Create one fact sheet from JSON, import one or more JSON objects, or import an ARCH-Insight ZIP export:

arch factsheet create application.json
arch factsheet import fact-sheets.json
arch factsheet import archi_insight_export.zip
arch factsheet list

JSON imports create rows one at a time through the same API used by the web app. If an item fails, earlier successful items remain created. ZIP imports use the application's import endpoint and report imported and skipped entries.

Secrets

The dedicated arch-secrets command remains available. The same functionality can be reached through arch secrets:

export ARCH_SECRETS_TOKEN='your-vault-token'
arch secrets run -- npm start
arch secrets export > .env
arch secrets push .env

The vault token is scoped independently from the user access token used by product commands.

Developer platform

arch repo list
arch repo create team/sample --description "Example repository"
arch pipeline list --repo 12
arch pipeline show 42
arch pipeline logs 99
arch registry list
arch registry tags team/sample
arch runner list
arch deploy list production