Vizra.ai |

Documentation

๐Ÿ’ป

Artisan Commands

Your CLI toolkit for building amazing AI agents! Master these commands to create, debug, and deploy intelligent agents with ease.

๐Ÿš€

Power at Your Fingertips!

Vizra's Artisan commands are your Swiss Army knife for AI agent development. From creating new agents to debugging complex interactions, everything is just a command away!

๐Ÿ› ๏ธ Agent Development Commands

Let's start building! These commands help you scaffold new agents and tools in seconds.

๐Ÿค– vizra:make:agent

Create a new AI agent with a single command! This is where the magic begins.

# Create a new agent interactively
php artisan vizra:make:agent

# The command will prompt for the agent name
# Creates: app/Agents/YourAgent.php

โœจ What you get:

  • โœ“ Name, description, and instructions properties ready to customize
  • โœ“ Model configuration (defaults to the blazing-fast gemini-2.0-flash)
  • โœ“ Temperature and max tokens settings pre-configured
  • โœ“ Empty tools array ready for your custom capabilities

๐Ÿ”ง vizra:make:tool

Give your agents superpowers! Tools let your agents interact with databases, APIs, and more.

# Create a new tool interactively
php artisan vizra:make:tool

# The command will prompt for the tool name
# Creates: app/Tools/YourTool.php

โšก Smart features:

  • โ†’ Tool names are automatically snake_cased for consistency
  • โ†’ "_tool" suffix is intelligently removed from the name
  • โ†’ Implements ToolInterface with definition() and execute() methods
  • โ†’ Includes JSON schema parameter definition for type safety

๐Ÿ“Š vizra:make:eval

Quality assurance for your AI! Create evaluations to ensure your agents perform consistently.

# Create a new evaluation interactively
php artisan vizra:make:eval

# The command will prompt for the evaluation name
# Creates: app/Evaluations/YourEvaluation.php

๐Ÿ” Agent Discovery Commands

Explore your AI workforce! These commands help you discover and manage your agents.

๐Ÿ” vizra:discover-agents

See all your available agents! This command shows you every agent in your application, whether registered or not.

# Discover all agents
php artisan vizra:discover-agents

# Clear discovery cache and rediscover
php artisan vizra:discover-agents --clear-cache

โœจ What you'll see:

  • โœ“ Complete list of all agents in your app/Agents directory
  • โœ“ Agent names, class names, and registration status
  • โœ“ Automatic discovery of new agents without manual registration
  • โœ“ Clear indication of which agents are already registered vs available

๐ŸŽ›๏ธ Options:

  • โ†’ --clear-cache - Force rediscovery by clearing the cache

๐Ÿ’ก Auto-Discovery Note:

Vizra ADK automatically discovers and registers agents when you use them. You don't need to manually register agents in your AppServiceProvider anymore! Just create an agent and start using it.

๐Ÿ’ฌ Agent Interaction Commands

Time to talk! These commands let you interact with your agents directly from the terminal.

๐Ÿ—ฃ๏ธ vizra:chat

Have a conversation with your AI agent right in your terminal! Perfect for testing and development.

php artisan vizra:chat {agent_name}

# Example: Chat with the weather reporter agent
php artisan vizra:chat weather_reporter

# Type "exit" or "quit" to end the chat

๐ŸŒŸ Cool features:

  • โ€ข Interactive terminal-based chat interface for instant feedback
  • โ€ข Unique session ID for each chat to track conversations
  • โ€ข Handles string, array, and object responses gracefully
  • โ€ข Comprehensive error handling so nothing breaks

๐Ÿงช Evaluation Commands

Test your agents like a pro! Run comprehensive evaluations to ensure quality at scale.

๐ŸŽฏ vizra:run:eval

Put your agents through their paces! Run evaluations to measure performance and catch regressions.

php artisan vizra:run:eval {name} [--output=results.csv]

# Example: Run CustomerServiceEvaluation
php artisan vizra:run:eval CustomerServiceEvaluation

# Save results to CSV file
php artisan vizra:run:eval CustomerServiceEvaluation --output=results.csv

๐ŸŽ›๏ธ Options:

  • โ†’ name - The evaluation class name (e.g., MyTestEvaluation)
  • โ†’ --output - Path to save CSV results for analysis

๐Ÿ“ˆ What you'll see:

  • โœ“ Real-time progress bar during evaluation
  • โœ“ Summary statistics with pass/fail counts
  • โœ“ Detailed results with assertion breakdowns
  • โœ“ CSV export with all test data for deeper analysis

๐Ÿ” Debugging Commands

Become a debugging detective! These commands help you understand exactly what your agents are doing.

๐Ÿ•ต๏ธ vizra:trace

X-ray vision for your agents! See every step of execution in beautiful detail.

php artisan vizra:trace {session_id} [options]

# View trace in tree format (default)
php artisan vizra:trace abc123

# View specific trace ID
php artisan vizra:trace abc123 --trace-id=xyz789

# Show detailed span data
php artisan vizra:trace abc123 --show-input --show-output --show-metadata

# Show only errors
php artisan vizra:trace abc123 --errors-only

# Different output formats
php artisan vizra:trace abc123 --format=table
php artisan vizra:trace abc123 --format=json

๐ŸŽ›๏ธ Powerful options:

  • โ†’ --trace-id - Zero in on a specific trace
  • โ†’ --show-input - See what went in
  • โ†’ --show-output - See what came out
  • โ†’ --show-metadata - View all the extra details
  • โ†’ --errors-only - Focus on problems
  • โ†’ --format - Choose your view: tree, table, or json

๐Ÿงน vizra:trace:cleanup

Keep things tidy! Clean up old trace data to save space and maintain performance.

# Clean up traces older than config value (default: 30 days)
php artisan vizra:trace:cleanup

# Clean up traces older than 7 days
php artisan vizra:trace:cleanup --days=7

# Preview what would be deleted
php artisan vizra:trace:cleanup --dry-run

# Skip confirmation prompt
php artisan vizra:trace:cleanup --force

๐Ÿง  Vector Memory Commands

Give your agents perfect memory! Store and search through knowledge using advanced vector embeddings.

๐Ÿ’พ vector:store

Feed your agent's brain! Store documents, manuals, and knowledge for instant recall.

php artisan vector:store {agent} [options]

# Store content from a file
php artisan vector:store customer_support --file=docs.txt

# Store direct content
php artisan vector:store customer_support --content="Important product information"

# With metadata
php artisan vector:store customer_support \
    --file=manual.pdf \
    --namespace=products \
    --source=manual \
    --source-id=v2.0 \
    --metadata='{"category":"electronics","version":"2.0"}'

๐ŸŽ›๏ธ Storage options:

  • โ†’ --file - Path to document or file
  • โ†’ --content - Direct text to store
  • โ†’ --namespace - Organize your memories
  • โ†’ --source - Track where it came from
  • โ†’ --source-id - Version or ID tracking
  • โ†’ --metadata - Extra context as JSON

๐Ÿ”Ž vector:search

Find anything instantly! Search through your agent's knowledge with semantic understanding.

php artisan vector:search {agent} {query} [options]

# Basic search
php artisan vector:search customer_support "refund policy"

# Search with custom parameters
php artisan vector:search customer_support "shipping rates" \
    --limit=10 \
    --threshold=0.8 \
    --namespace=policies

# Generate RAG context
php artisan vector:search customer_support "product warranty" --rag

# JSON output
php artisan vector:search customer_support "user manual" --json

๐ŸŽ›๏ธ Search options:

  • โ†’ --namespace - Search specific memory spaces
  • โ†’ --limit - How many results to return
  • โ†’ --threshold - Similarity score (0.0-1.0)
  • โ†’ --rag - Get formatted context for agents
  • โ†’ --json - Machine-readable output

๐Ÿ“Š vector:stats

Monitor your memory usage! Get insights into how your vector storage is performing.

# Global statistics
php artisan vector:stats

# Agent-specific statistics
php artisan vector:stats customer_support

# Detailed statistics
php artisan vector:stats --detailed

# Specific namespace
php artisan vector:stats customer_support --namespace=products

# JSON output
php artisan vector:stats --json

๐Ÿฏ Setup Commands

Get started quickly! These commands help you set up and configure Vizra ADK.

๐Ÿ“ฆ vizra:install

One command to rule them all! Install everything you need to start building agents.

php artisan vizra:install

# This command:
# - Publishes configuration files
# - Publishes database migrations
# - Shows post-installation information

๐ŸŒ vizra:dashboard

Access your command center! Launch the web dashboard to test and monitor your agents.

# Display dashboard URL
php artisan vizra:dashboard

# Open dashboard in browser
php artisan vizra:dashboard --open

๐Ÿ’ก Pro Tips for Command Line Warriors

๐ŸŽฏ Development Flow

  • โ€ข Use vizra:chat for rapid testing
  • โ€ข Create agents and tools with make commands
  • โ€ข Debug with traces when things get complex

๐Ÿš€ Production Excellence

  • โ€ข Run evaluations before deploying
  • โ€ข Clean up traces to save storage
  • โ€ข Monitor vector memory performance

๐Ÿš€ Ready to Build Something Amazing?

You now have all the command-line tools at your disposal. Start creating intelligent agents that can solve real problems!