CLI
Vyges CLI Reference
Complete reference for all Vyges CLI commands, options, and usage examples. The Vyges CLI provides over 45 commands covering the complete functional IP development lifecycle.
💡 Quick Navigation
Use the sidebar to jump to specific commands, or use the search box to find commands quickly.
Command Categories
The Vyges CLI provides over 45 commands organized into the following categories:
Core Commands
vyges init
vyges init [OPTIONS] [NAME]
vyges quickstart
vyges quickstart [OPTIONS] [NAME]
vyges setup
vyges setup [OPTIONS]
vyges expand
vyges expand [OPTIONS]
vyges validate
vyges validate [OPTIONS]
vyges test
vyges test [OPTIONS]
vyges publish
vyges publish [OPTIONS]
Generation
vyges generate
vyges generate [OPTIONS]
vyges diagram
vyges diagram [OPTIONS]
vyges scaffold
vyges scaffold [OPTIONS]
Templates
vyges templates
vyges templates [OPTIONS]
AI & Intelligence
vyges ai
vyges ai [OPTIONS] <ACTION>
Trust & Compliance
vyges trust
vyges trust [OPTIONS]
Development
vyges doctor
vyges doctor [OPTIONS]
vyges lint
vyges lint
vyges synthesis
vyges synthesis
vyges simulation
vyges simulation
vyges coverage
vyges coverage
vyges testbench
vyges testbench
vyges flow
vyges flow
Documentation
vyges readme
vyges readme
Configuration
vyges auth
vyges auth [OPTIONS]
vyges config
vyges config [OPTIONS]
vyges completion
vyges completion [OPTIONS] [SHELL]
vyges info
vyges info [OPTIONS]
vyges update
vyges update [OPTIONS]
vyges clean
vyges clean [OPTIONS]
vyges format
vyges format [OPTIONS]
vyges import
vyges import [OPTIONS]
Installation
The Vyges CLI is available as pre-built binaries for early access users.
Early Access
Apply for early access to get the Vyges CLI binary and start building silicon like software.
Early contributors get special recognition and influence on platform direction
Quick Start Guide
Get started with Vyges CLI in minutes:
1. Initialize a new project
# Quick setup with defaults
vyges quickstart
# Interactive setup
vyges init --interactive2. Validate your project
# Basic validation
vyges validate
# Strict validation
vyges validate --strict3. Run tests
# Run all tests
vyges test --all
# Simulation only
vyges test --simulation4. Generate documentation
# Generate README
vyges generate readme --include-diagram
# Generate complete documentation
vyges docs generateConfiguration
Vyges CLI can be configured through environment variables, configuration files, or command-line options:
Environment Variables
# API configuration
export VYGES_API_URL=https://api.vyges.com
export VYGES_TOKEN=your_access_token
# Tool preferences
export VYGES_SIMULATOR=verilator
export VYGES_SYNTHESIS_TOOL=openlaneConfiguration Commands
# Set configuration
vyges config set api_url https://api.vyges.com
# View configuration
vyges config list
# Reset configuration
vyges config resetAuthentication
Some commands require authentication with your Vyges account:
Login to Vyges
# Interactive login (opens browser)
vyges auth login
# CI/CD login
vyges auth login --ciCheck authentication status
vyges auth statusExamples
Common usage patterns and examples:
Create a new UART controller project
# Initialize with UART template
vyges init uart-controller --template uart-controller
# Validate the project
vyges validate
# Run tests
vyges test --all
# Generate documentation
vyges generate readme --include-diagramWork with existing IP blocks
# Import existing IP
vyges import /path/to/existing/ip
# Validate imported IP
vyges validate --strict
# Generate diagrams
vyges diagram block --ip uart-controllerAI-assisted development
# Get AI suggestions
vyges ai suggest --context "I need a FIFO buffer"
# Interactive AI chat
vyges ai chat
# Generate code with AI
vyges ai generate --type fifo --depth 8