Agentuity Docs

The CLI includes commands designed for AI coding agents, IDE integrations, and tooling that needs to understand the Agentuity CLI programmatically.

CLI Capabilities

Show the CLI's capabilities in a structured format for AI consumption:

agentuity ai capabilities show

This outputs a machine-readable description of what the CLI can do, useful for:

AI coding agents that need to understand available commands
IDE extensions building Agentuity integrations
Documentation generators

Schema Inspection

Output the CLI's command schema for programmatic consumption:

# Show the full CLI schema
agentuity ai schema show
 
# Generate schema in a specific format
agentuity ai schema generate

The schema includes:

All available commands and subcommands
Required and optional parameters
Parameter types and validation rules
Command descriptions and examples

Prompt Generation

Generate context-aware prompts for LLMs working with Agentuity projects:

# Generate prompt for building agents
agentuity ai prompt agent
 
# Generate prompt for building APIs
agentuity ai prompt api
 
# Generate general LLM prompt
agentuity ai prompt llm
 
# Generate prompt for web/frontend development
agentuity ai prompt web

Each prompt type includes:

Relevant SDK patterns and best practices
Code examples for the target domain
Common pitfalls to avoid
Links to documentation

Use Cases

These prompts are useful for:

Bootstrapping AI coding sessions with Agentuity context
Training custom AI assistants on Agentuity patterns
Generating project-specific documentation

Integration Examples

IDE Extension

Use the CLI to provide autocomplete, validation, and project configuration help:

// Get CLI capabilities for IDE integration
const { execSync } = require('child_process');
 
const capabilities = JSON.parse(
  execSync('agentuity --json ai capabilities show').toString()
);
 
// Use capabilities to build autocomplete, validation, etc.

// Get agentuity.json schema for configuration validation
const schema = JSON.parse(
  execSync('agentuity --json ai schema generate').toString()
);
 
// Use schema to validate project configuration files

AI Coding Agent

# Generate context for an AI agent working on your project
agentuity ai prompt agent > /tmp/agentuity-context.md
 
# Include in your AI agent's system prompt
cat /tmp/agentuity-context.md

Next Steps

Getting Started with the CLI: Install and authenticate
Local Development: Run agents locally
Creating Agents: Build your first agent

Need Help?

Join our Community for assistance or just to hang with other humans building agents.

Send us an email at hi@agentuity.com if you'd like to get in touch.

Please Follow us on

If you haven't already, please Signup for your free account now and start building your first agent!

AI Commands