VoiceGateway // DOCS

voicegw projects / voicegw project

List all configured projects or show details for a single project.

voicegw projects / voicegw project

List all configured projects or show details for a single project.

Purpose

The projects command lists every project defined in the gateway configuration, showing their name, tags, daily budget, and default stack. The project command shows full details for a single project, including today's spend if cost tracking is enabled.

Syntax

Shell
# List all projects
voicegw projects [OPTIONS]

# Show a single project
voicegw project <PROJECT_ID> [OPTIONS]

Options (projects)

FlagShortTypeDefaultDescription
--config-cstringnullPath to voicegw.yaml. Auto-discovered if omitted.

Options (project) {#project-detail}

ArgumentTypeRequiredDescription
PROJECT_IDstringyesThe project ID to display.
FlagShortTypeDefaultDescription
--config-cstringnullPath to voicegw.yaml. Auto-discovered if omitted.

Output (projects)

A table with columns:

ColumnDescription
IDProject identifier (e.g., tonys-pizza).
NameHuman-readable name.
TagsSpace-separated tags.
Budget/dayDaily budget in USD, or - if unlimited.
Default StackNamed stack, or - if none.

Output (project)

A Rich panel showing:

  • Project name and description.
  • Tags, default stack, and daily budget.
  • Today's spend and request count (if cost tracking is enabled).

Examples

List all projects

Shell
voicegw projects
Plain text
                    Projects
┌──────────────┬──────────────┬────────────┬────────────┬───────────────┐
│ ID           │ Name         │ Tags       │ Budget/day │ Default Stack │
├──────────────┼──────────────┼────────────┼────────────┼───────────────┤
│ tonys-pizza  │ Tony's Pizza │ production │ $10.00     │ premium       │
│ sushi-bot    │ Sushi Bot    │ staging    │ $5.00      │ budget        │
│ dev-sandbox  │ Dev Sandbox  │ dev        │ $1.00      │ local         │
└──────────────┴──────────────┴────────────┴────────────┴───────────────┘

Show details for a single project

Shell
voicegw project tonys-pizza
Plain text
╭─ Project: tonys-pizza ───────────────────╮
│ Tony's Pizza                              │
│ Pizza ordering voice agent                │
│                                           │
│ Tags: production                          │
│ Default Stack: premium                    │
│ Daily Budget: $10.00                      │
╰───────────────────────────────────────────╯

Today: $2.4500 (120 requests)

List projects with a custom config

Shell
voicegw projects -c /etc/voicegateway/voicegw.yaml

Exit Codes

CodeMeaning
0Success (including when no projects are configured -- prints a warning).
1Config failed to load, or the specified project ID was not found.

On this page