CLI Reference

Reference for all Kirox CLI commands and options.

Command List

kirox

Main command. Fetches .kiro/ files from GitHub repositories.

npx kirox <owner/repo> [options]

add

Adds new projects to existing local projects.

npx kirox add <owner/repo> [options]

completion

Outputs shell completion scripts.

npx kirox completion <shell>

Global Options

Options available for all commands:

Option	Short	Description
--help	-h	Display help
--version	-V	Display version

Common Options

Options available for kirox and add commands:

Option	Short	Type	Description
--project	-p	string	Project name(s) (comma-separated for multiple)
--force	-f	boolean	Skip overwrite confirmation
--dry-run		boolean	Simulate file writing
--verbose		boolean	Display detailed logs
--track		boolean	Enable update tracking
--steering		boolean	Fetch steering only
--subdirectory		string	Subdirectory path
--config	-c	string	Configuration file path

Usage Examples

Basic Usage

# Fetch specific project
npx kirox yukihirop/my-project -p api-spec

# Interactive mode
npx kirox

# Display help
npx kirox --help

With Options

# Fetch multiple projects
npx kirox yukihirop/my-project -p api-spec,web-spec

# Specify branch
npx kirox yukihirop/my-project#develop -p api-spec

# No confirmation
npx kirox yukihirop/my-project -p api-spec --force

# Dry run
npx kirox yukihirop/my-project -p api-spec --dry-run

# Verbose logs
npx kirox yukihirop/my-project -p api-spec --verbose

Subcommands

# Add project
npx kirox add yukihirop/my-project -p new-project

# Generate shell completion scripts
npx kirox completion bash > /etc/bash_completion.d/kirox
npx kirox completion zsh > ~/.zsh/completion/_kirox
npx kirox completion fish > ~/.config/fish/completions/kirox.fish

Next Steps

• kirox command: Details on main command
• add command: Details on add subcommand
• completion command: Details on completion subcommand