A command-line interface for setting up Rice in your JavaScript/TypeScript projects.
This tool helps you:
- Configure Rice Storage and State services.
- Generate
rice.config.js. - Populate environment variables in
.env. - Verify connectivity to your Rice instance.
To install the latest version automatically:
curl -fsSL https://raw.githubusercontent.com/shankha98/rice-cli/main/install.sh | bashThis will install the rice command to /usr/local/bin.
Download the pre-built binary for your platform from the Releases page.
To build from source, ensure you have Rust installed:
cargo install --path .Run the CLI in the root of your project:
# Setup Rice (Interactive) - Default
cargo run -- setup
# OR
cargo run
# Show current configuration
cargo run -- config
# Check connection to Rice instance
cargo run -- check
# Show help
cargo run -- --helpThe setup command (setup or default) will guide you through:
- Enable/Disable Storage and State services.
- Provide connection details (URL, Auth Token, etc.).
- Generate
rice.config.jsand update.env. - Verify connection to the Rice instance.
The config command reads .env and rice.config.js in the current directory and displays the configured values (masking sensitive tokens).
The check command uses the configured values to attempt a connection to the Rice instance health endpoint.
make build: Build the project.make run: Run the CLI.make test: Run unit tests.make integration-test: Run integration tests using a temporary project directory.
Proprietary. All Rights Reserved.