Skip to content

Quick Start

CLI-first journey for sharecli (FR-001, FR-002, FR-003).

StepActionFR
1. InstallBuild or install the binaryNFR-001
2. ConfigureInit TOML configFR-002
3. RegisterAdd a project pathFR-003
4. RunStart / list / stop a processFR-001
5. VerifyStatus / healthFR-004

Estimated duration: ~5 minutes

Installation

bash
# From a git checkout
cargo build --release
./target/release/sharecli --version

# Or install
cargo install sharecli
# cargo binstall sharecli

Configuration

bash
sharecli config init
sharecli config validate
sharecli config show

Config lives under the platform config directory ($XDG_CONFIG_HOME/sharecli/config.toml or OS equivalent). See FR-002.

Register a project

bash
sharecli project add demo /path/to/repo
sharecli project list
sharecli project show demo

Run & verify

bash
sharecli start demo --harness node
sharecli ps --project demo
sharecli status
sharecli stop --all

Friction

If a step fails with a generic error, log it in docs/friction-log.md and cite the FR above.