Installation
The CLI binary is included in the project and can be run with:Create an Alias
For faster development, create an alias for the CLI: Bash/Zsh (Linux/macOS):Install Globally
For production use, install the CLI globally:Available Commands
The CLI tool provides the following commands:| Command | Description |
|---|---|
version | Show framework version and info |
db-check | Check database connection and health |
down | Put the application into maintenance mode |
up | Bring the application out of maintenance mode |
storage | Storage management commands (check, link, info, init) |
test | Run CLI diagnostics |
Project Root Detection
The CLI automatically detects and changes to the project root directory by searching forCargo.toml. You can run CLI commands from anywhere within your project directory tree.
Output example:
Getting Help
View all available commands:Running the Application
The project has two binaries:| Binary | Command | Purpose |
|---|---|---|
main | cargo run --bin main | API Server (default) |
ironclad | cargo run --bin ironclad | CLI Tool |
Common Workflows
Development Workflow
Initial Setup Workflow
Next Steps
Version Command
Display framework version and information
Database Command
Check database connectivity and health
Maintenance Mode
Manage application maintenance mode
Storage Management
Initialize and manage storage directories