The Tracel CLI (tracel) is the command-line tool for interacting with Tracel Console, the centralized platform for experiment tracking, model sharing, and deployment for Burn users.
This CLI works in conjunction with the Tracel SDK to provide a seamless workflow for:
- Running training jobs locally or remotely
- Managing experiments and tracking metrics
- Packaging and deploying models
- Integrating with compute providers
- Managing project configurations
cargo install tracel-cligit clone https://github.com/tracel-ai/tracel-cli.git
cd tracel-cli
cargo install --path crates/tracel-cliAfter installation, the tracel command will be available in your terminal.
- Tracel Account: Create an account at console.tracel.ai
- Rust: Version 1.87.0 or higher
- Tracel SDK: Add the SDK to your Burn project
Run your project locally. This is a thin alias for cargo run: every argument
after -- is forwarded to your binary, so tracel train -- <args> is equivalent
to cargo run -- <args>. stdin/stdout/stderr are inherited and the binary's
exit code is propagated.
# Equivalent to `cargo run`
tracel train
# Equivalent to `cargo run -- train mnist --epochs 100`
tracel train -- train mnist --epochs 100Package your project for deployment on remote compute providers.
tracel packageThis creates a deployable artifact containing your code, dependencies, and configurations.
Authenticate with the Console platform.
tracel loginInitialize or reinitialize a Tracel project in the current directory.
# Interactive initialization
tracel initUnlink the current directory from Tracel project.
tracel unlinkDisplay information about the currently authenticated user.
tracel meDisplay information about the current project.
tracel projectThe Tracel CLI is organized as a Cargo workspace:
tracel-cli/
├── crates/
│ └── tracel-cli/
└── xtask/ # Build utilities
cargo run --bin tracel-- --helpcargo testFor testing against a local Console instance:
tracel --dev loginThis connects to http://localhost:9001 and uses separate development credentials.
Contributions are welcome! Please feel free to:
- Report issues or bugs
- Request new features
- Submit pull requests
- Improve documentation
Licensed under either of:
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.