Core Concepts
CLI
The developer command-line interface for project scaffolding, validation, and automation.
Overview
The Asiyst CLI (asiyst) bridges your local codebase and the Asiyst Cloud. It enables engineers to manage assistants, sync documentation, inspect live health, and run assistant regression tests directly from the terminal.
CLI Features
- Automated Scaffolding: Detects Next.js, React, or Vite projects and automatically injects initialization code.
- Knowledge Synchronization: Uploads local Markdown files, code files, and schema definitions into project knowledge.
- Offline Validation: Verifies project credentials and domain registrations before git push.
Common Commands
# Authenticate with browser OAuth
asiyst login
# Inspect active project health
asiyst status
# Validate local integration
asiyst validate
# Synchronize local docs directory
asiyst knowledge sync ./docs
CI/CD Integration
Use the CLI in GitHub Actions or GitLab CI with an API token:
- name: Validate Asiyst Assistant
run: npx asiyst validate --project $ASIYST_PROJECT_ID
env:
ASIYST_API_TOKEN: ${{ secrets.ASIYST_API_TOKEN }}
Read the full CLI Guide or CLI Command Reference.