@cstar.help/cli

@cstar.help/cli

CLI tool for the cStar customer support platform. Manage API keys, forward webhooks locally, stream logs, and run as an MCP server for AI agents.

Install

npm install -g @cstar.help/cli

Quick Start

# Authenticate
cstar login --api-key sk_test_abc123

# Check connection
cstar status

# Forward webhooks to your local server
cstar listen --forward-to http://localhost:3000/webhook

# Fire a test event
cstar trigger ticket.created

# Stream API logs
cstar logs --tail

Commands

cstar login

Authenticate and store credentials locally at ~/.cstar/config.json.

cstar login --api-key sk_live_abc123

cstar logout

Remove stored credentials.

cstar logout

cstar status

Show current authentication state, team info, and rate limits.

cstar status

cstar listen

Forward webhook events to a local URL. Replaces ngrok for webhook development.

# Default: forwards to http://localhost:3000/api/webhooks
cstar listen

# Custom URL
cstar listen --forward-to http://localhost:8080/webhook

# Filter specific events
cstar listen --forward-to http://localhost:3000/webhook --events ticket.created,customer.created

Events are forwarded with these headers:

• X-Webhook-Secret — signing secret for verification
• X-Event-Type — event type (e.g., ticket.created)
• X-Event-ID — unique event ID

cstar trigger <event>

Fire a test webhook event to all active endpoints (or a specific one).

cstar trigger ticket.created
cstar trigger boss.spawned --webhook-id wh_xyz

cstar logs

View and stream API request logs.

# Recent logs (last hour, 20 entries)
cstar logs

# Stream in real-time
cstar logs --tail

# Filter by method and status
cstar logs --method POST --status 5xx --since 24h --limit 50

cstar keys list

List all API keys for your team.

cstar keys list
cstar keys list --environment test

cstar keys create

Create a new API key. The full key is shown only once.

cstar keys create --name "My Integration" --type secret
cstar keys create --name "Widget Key" --type publishable --environment live

cstar keys revoke <keyId>

Revoke an API key.

cstar keys revoke key_abc123

cstar events

List available webhook event types.

cstar events
cstar events --category tickets
cstar events --category gamification

Supported events:

Category	Events
Tickets	ticket.created, ticket.updated, ticket.closed, ticket.message_added
Customers	customer.created, customer.updated
Articles	article.created, article.published, article.updated
Gamification	boss.spawned, boss.defeated, player.level_up

cstar mcp-server

Run as an MCP server for AI agents (Claude, Cursor, etc.).

cstar mcp-server --stdio

Add to your Claude Desktop config:

{
	"mcpServers": {
		"cstar": {
			"command": "npx",
			"args": ["@cstar.help/cli", "mcp-server", "--stdio"]
		}
	}
}

Exposed tools: cstar_list_tickets, cstar_get_ticket, cstar_create_ticket, cstar_list_customers, cstar_get_customer, cstar_list_articles, cstar_trigger_webhook, cstar_get_status

Global Options

All commands support these flags:

Flag	Description
--json	Output structured JSON (for scripts and AI agents)
--api-key <key>	Override stored API key
--base-url <url>	Override API base URL
--no-color	Disable colored output
--version	Show CLI version

JSON Mode

Every command supports --json for machine-readable output:

cstar status --json
# { "success": true, "data": { "team": "Acme", "environment": "test", ... } }

cstar logs --tail --json
# Streams NDJSON (one JSON object per line)

Requirements

• Node.js 18+

License

MIT