CLI Commands Reference

This page documents every command, argument, and option available in the slack-ticket CLI. All commands support --help for quick reference.


General Usage

slack-ticket [command] [options]

Commands Overview

CommandDescription
setupInteractive first-time configuration
createConvert Slack thread to GitHub issue
updateAppend new Slack messages to existing issue
doctorValidate tokens and permissions
config viewDisplay current configuration
config editOpen config in editor

setup

Interactive wizard for first-time configuration. Safe to re-run to update values.

slack-ticket setup

When to use: After installation or when updating API keys or default repository settings.


create — Generate GitHub Issue

The core command—fetches a Slack thread and creates a structured GitHub issue using AI.

slack-ticket create <slack-thread-url> [options]

Arguments

ArgumentRequiredDescription
slack-thread-urlYesFull URL of the starting message in a Slack thread

Example: slack-ticket create https://myworkspace.slack.com/archives/C12345/p1679090123456789

Options

OptionAliasDescriptionDefault
--depth <n>-Number of thread messages to fetch (1-10)3
--severity <level>-Issue severity: low, medium, high, criticalConfig default
--component <name>-Component name (must match config labels)-
--repo <owner/repo>-Override target repositoryConfig default
--project <project-id>-Override GitHub Project v2 IDConfig default
--no-project-Skip project assignment for this run-
--no-image-Skip image handling for this run-
--labels <labels>-Comma-separated additional labels-
--yes-ySkip confirmation prompt-
--dry-run-Preview without creating issue-

Examples

# Basic usage with default settings
slack-ticket create https://yourworkspace.slack.com/archives/C123/p123

# Fetch deeper thread context (up to 10 messages)
slack-ticket create <url> --depth 10

# Create with specific severity and component
slack-ticket create <url> --severity high --component backend

# Override repository for this specific issue
slack-ticket create <url> --repo your-org/other-repo

# Preview what would be generated without creating
slack-ticket create <url> --dry-run

update — Append to Existing Issue

Add new Slack messages to an existing GitHub issue, keeping context alive as discussions evolve.

slack-ticket update <issue-number> <slack-message-url...> [options]

Arguments

ArgumentRequiredDescription
issue-numberYesNumeric ID of the GitHub issue
slack-message-url...YesOne or more Slack message URLs

Options

OptionAliasDescriptionDefault
--repo <owner/repo>-Override target repositoryConfig default
--comment-Add as issue comment instead of updating body-
--yes-ySkip confirmation prompt-
--dry-run-Preview without updating-

Examples

# Update issue with new Slack messages
slack-ticket update 42 https://yourworkspace.slack.com/archives/C123/p456

# Add as a comment instead of updating the issue body
slack-ticket update 42 <url> --comment

# Multiple Slack messages at once
slack-ticket update 42 <url1> <url2> <url3>

doctor — Diagnostics

Validate all configured tokens and permissions. Run this when experiencing issues.

slack-ticket doctor

Checks:

Example output:

✓ Slack: Token valid, channels accessible
✓ GitHub: Token valid, repo permissions confirmed
✓ AI Provider: Connection successful

config view — Display Configuration

Print current configuration with sensitive tokens masked.

slack-ticket config view

Useful for verifying settings without exposing API keys.


config edit — Edit Configuration

Open configuration file in your system’s default editor.

slack-ticket config edit

This uses the $EDITOR environment variable (defaults to vi on most systems).

Common edits:


Global Options

OptionAliasDescription
--version-vShow version number
--help-hShow help information

Exit Codes

CodeMeaning
0Success
1General error
2Invalid arguments
3AI provider error
4AI output validation failed
5Network/API error
6Configuration error

Tips for Teams

  1. Use --dry-run to preview AI-generated issues before creating
  2. Use --yes in CI/CD pipelines to skip prompts
  3. Run doctor if authentication errors occur
  4. Combine with shell scripts for batch processing multiple threads

Learn more about AI analysis or the creation workflow.