@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 and team info.

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.deleted, ticket.message_added | | Customers | customer.created, customer.updated, customer.deleted | | Articles | article.created, article.published, article.updated, article.deleted | | Gamification | boss.spawned, boss.defeated, boss.damaged, player.level_up, player.achievement_unlocked, player.xp_gained, player.quest_completed, player.streak_milestone | | Social | social.one_up_sent, social.high_five_sent | | Community | community_post.created, community_post.updated, community_post.deleted, community_post.commented, community_post.voted, community_post.status_changed | | CSAT | survey.submitted |

cstar community list

List community posts with optional filters.

# All posts
cstar community list

# Filter by topic, status, or sort order
cstar community list --topic <topicId> --status open --sort votes

# Pagination
cstar community list --page 2 --page-size 10

cstar community get <id>

Get a single community post with comments.

cstar community get <postId>

cstar community topics

List all community topics.

cstar community topics

cstar community create

Create a new community post.

cstar community create --title "Feature Request" --topic-id <topicId>
cstar community create --title "Bug Report" --topic-id <topicId> --body "Details here" --visibility public

cstar analytics

View team analytics overview.

cstar analytics
cstar analytics --period month

| Flag | Description | | ---------------------- | --------------------------------------------------------------------------- | | --period <period> | Time period: day, week, month, quarter (default: week) | | --type <type> | Analytics type: overview, tickets, performance, library (default: overview) | | --agent-id <agentId> | Agent ID (for performance type only) |

cstar automations list

List automation rules.

cstar automations list
cstar automations list --enabled --trigger ticket.created

| Flag | Description | | ------------------- | ----------------------- | | --enabled | Show only enabled rules | | --trigger <event> | Filter by trigger event |

cstar automations create

Create a new automation rule.

cstar automations create --name "Auto-close stale" --trigger ticket.updated
cstar automations create --from-file rule.json --name "From file" --trigger ticket.created

| Flag | Description | | ---------------------- | ------------------------ | | --name <name> | Rule name (required) | | --trigger <event> | Trigger event (required) | | --description <desc> | Rule description | | --from-file <path> | Create from a JSON file |

cstar automations toggle <ruleId>

Enable or disable a rule.

cstar automations toggle rule_abc --enable
cstar automations toggle rule_abc --disable

cstar automations test <ruleId>

Dry-run a rule against a resource.

cstar automations test rule_abc --ticket tkt_xyz

cstar automations executions [ruleId]

View execution history.

cstar automations executions
cstar automations executions rule_abc --limit 50

cstar automations delete <ruleId>

Delete an automation rule.

cstar automations delete rule_abc

cstar game boss status

Show current boss battle status.

cstar game boss status

cstar game leaderboard

Show the team leaderboard.

cstar game leaderboard
cstar game leaderboard --period allTime

| Flag | Description | | ------------------- | ------------------------------------------------ | | --period <period> | Period: daily, weekly, allTime (default: weekly) |

cstar game achievements

List achievements for a user.

cstar game achievements --user-id usr_abc123
cstar game achievements --user-id usr_abc123 --unlocked

| Flag | Description | | -------------------- | ------------------ | | --user-id <userId> | User ID (required) | | --unlocked | Show unlocked only | | --category <cat> | Filter by category |

cstar game quests

Show today's quests for a user.

cstar game quests --user-id usr_abc123

| Flag | Description | | -------------------- | ------------------ | | --user-id <userId> | User ID (required) |

cstar game player

Show player stats for a user.

cstar game player --user-id usr_abc123

| Flag | Description | | -------------------- | ------------------ | | --user-id <userId> | User ID (required) |

cstar members list

List all team members.

cstar members list
cstar members list --role agent

| Flag | Description | | --------------- | -------------- | | --role <role> | Filter by role |

cstar members get <id>

Get details for a specific team member.

cstar members get mem_abc123

cstar search <query>

Search across tickets, customers, and articles.

cstar search "billing issue"
cstar search "reset password" --types tickets,articles --limit 20

| Flag | Description | | ----------------- | ------------------------------------------ | | --types <types> | Resource types to search (comma-separated) | | --limit <n> | Max results (default: 10) |

cstar seed

Bootstrap sample data (categories, articles, customers, tickets) for a help center. Useful for testing and demos.

cstar seed

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_list_community_posts, cstar_get_community_post, cstar_list_community_topics, cstar_create_community_post, cstar_trigger_webhook, cstar_get_status, cstar_list_events, cstar_list_members, cstar_search, cstar_analytics, cstar_boss_status, cstar_leaderboard, cstar_player_stats

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