Skip to content

Guide ​

Kirox CLI is an npx command-line tool to fetch Kiro specification and steering files from remote GitHub repositories.

Guide Index ​

Getting Started ​

Learn how to install and set up Kirox CLI.

Basic Usage ​

Learn the basic commands and options of Kirox CLI.

Advanced Usage ​

Utilize advanced features such as configuration files, branch specification, and subdirectory support.

Troubleshooting ​

Explore common issues and their solutions.

Key Features ​

  • Instant execution with npx: No global installation required
  • Overwrite protection: Confirmation prompt for existing files
  • Progress visualization: Real-time display of file fetching progress
  • Flexible configuration: Customize behavior with .kiroxrc.json
  • Error handling: Clear error messages and solutions

Next Steps ​

For beginners, we recommend starting with Getting Started.

Released under the MIT License.