Skip to content

CLI

Terminal window
cargo install carmy-cli

Carmy requires Rust 1.88 or newer (rustup update stable).

command effect
carmy new <name> create an application with the conventional layout
carmy new <name> --git depend on the main branch of the Git repository instead of crates.io
carmy new <name> --path <dir> depend on a local Carmy checkout instead of crates.io
carmy --version print the version
carmy --help print usage

carmy new:

  • validates the name: lowercase ASCII letters, digits, _ and -, starting with a letter; reserved names are refused
  • never overwrites an existing directory
  • runs git init when Git is available

A Carmy application built with carmy::run() accepts:

command effect
cargo run or cargo run -- server serve HTTP
cargo run -- mcp serve MCP over stdio
cargo run -- tools print the tool catalog as JSON

The same commands work on the compiled binary: ./target/release/shop mcp.