CLI

CLI Overview

Deep dive into the Asiyst CLI — the developer command-line interface for scaffolding, knowledge syncing, avatar publishing, and automation.

Overview

The Asiyst CLI (asiyst) is the official command-line interface for developers building with the Asiyst platform. Designed for local development workflows and automated CI/CD pipelines, the CLI provides complete control over project provisioning, knowledge base synchronization, avatar publishing, and integration health diagnostics.

npm install -g @asiyst/cli
asiyst --version
# asiyst/2.1.0 node/20.11.0 darwin-arm64

Core Command Groups

Command Group	Description	Example Usage
`auth`	Manage developer logins, OAuth tokens, and session revocations	`asiyst login`, `asiyst logout`
`projects`	Create, list, switch, and inspect project workspaces	`asiyst projects list`
`knowledge`	Synchronize local Markdown, sitemaps, and trigger vector re-indexing	`asiyst knowledge sync ./docs`
`avatar`	Validate 3D glTF models, inspect animations, and publish releases	`asiyst avatar publish`
`deploy`	Promote assistant configurations from dev to production	`asiyst deploy --env production`
`validate`	Check SDK credentials, domain whitelists, and live connectivity	`asiyst validate`
`chat`	Test assistant conversational turns directly inside your terminal	`asiyst chat`
`diagnostics`	Run comprehensive environment and network latency diagnostics	`asiyst diagnostics`

Global Flags & Environment Variables

Every command supports standard global flags:

--project : Scope command to a specific project ID (or set ASIYST_PROJECT_ID).

--env : Target development or production environment.

--json: Output raw, uncolored JSON for shell pipelines (jq / PowerShell).

--verbose: Display full HTTP request/response traces and timing headers.

--no-color: Disable ANSI terminal color codes.

Scriptability & JSON Output Mode

All CLI commands return deterministic exit codes (0 for success, non-zero for failure) and pipe cleanly into automation tools:

# Extract active project public key via jq
asiyst status --json | jq -r '.project.publicKey'

Docs/CLI

CLI