docs

Author: solidiquis

Cargo.toml

@@ -31,6 +31,7 @@ arrow-array = "58.3.0"
 arrow-schema = "58.3.0"
 async-channel = "2.2"
 async-trait = "^0.1"
+axum = "0.8"
 mockall = "0.14.0"
 bytes = "1.11.1"
 bytesize = "2"
@@ -48,6 +49,7 @@ futures = { version = "0.3", default-features = false, features = ["alloc"] }
 futures-core = "0.3"
 hyper = { version = "1.8", features = ["server", "http1"] }
 hyper-util = { version = "0.1.20", features = ["service", "server", "tokio"] }
+include_dir = "0.7"
 indicatif = "0.18"
 indoc = "2.0"
 parquet = "58.3.0"
@@ -73,6 +75,7 @@ toml = "0.9"
 tonic = { version = "^0.14", features = ["gzip"] }
 tonic-prost = "^0.14"
 tower = "^0.5"
+tower-serve-static = "0.1"
 tracing = "0.1"
 tracing-appender = "0.2"
 tracing-subscriber = { version = "0.3", features = ["fmt", "env-filter"] }

rust/crates/sift_cli/Cargo.toml

@@ -39,6 +39,9 @@ tokio = { workspace = true, features = ["full", "net", "time"] }
 tokio-stream = { workspace = true }
 toml = { workspace = true }
 zip = { workspace = true }
+axum.workspace = true
+tower-serve-static.workspace = true
+include_dir.workspace = true
 
 [dev-dependencies]
 indoc = { workspace = true }

rust/crates/sift_cli/assets/docs/src/agents/mcp.md

@@ -14,7 +14,7 @@ The server reads credentials from your configured profile, so make sure
 `sift-cli ping` succeeds first. Pass `--profile` and `--disable-tls` as needed:
 
 ```sh
-sift-cli --profile staging mcp
+sift-cli --profile mission mcp
 ```
 
 The server communicates over stdio and is meant to be launched by an MCP client,

rust/crates/sift_cli/assets/docs/src/getting-started/profiles.md

@@ -21,7 +21,7 @@ Pass `--profile <name>` to `config update`. The profile is created as its own
 TOML table:
 
 ```sh
-sift-cli config update --profile staging \
+sift-cli config update --profile mission \
   --grpc-uri https://api.staging.example.com \
   --rest-uri https://api.staging.example.com \
   --api-key "$SIFT_STAGING_API_KEY"
@@ -52,8 +52,8 @@ sift-cli config update --interactive
 `--profile` is a global flag, so it goes on any command that talks to Sift:
 
 ```sh
-sift-cli --profile staging ping
-sift-cli --profile staging import csv ./telemetry.csv --asset rover-1
+sift-cli --profile mission ping
+sift-cli --profile mission import csv ./telemetry.csv --asset rover-1
 ```
 
 Omit `--profile` to use the default profile.

rust/crates/sift_cli/assets/docs/src/getting-started/verifying.md

@@ -13,7 +13,7 @@ means your `grpc_uri` and `apikey` are correct and the network path is open.
 To verify a specific profile:
 
 ```sh
-sift-cli --profile staging ping
+sift-cli --profile mission ping
 ```
 
 For a non-TLS environment:

rust/crates/sift_cli/src/cli/mod.rs

@@ -4,7 +4,7 @@ use parquet::ComplexTypesMode;
 pub mod hdf5;
 pub mod tdms;
 use hdf5::Hdf5Schema;
-use std::path::PathBuf;
+use std::{net::SocketAddr, path::PathBuf};
 use tdms::TdmsFallbackMethod;
 
 pub mod channel;
@@ -41,6 +41,8 @@ pub enum Cmd {
     #[command(subcommand)]
     Config(ConfigCmd),
 
+    Doc(DocArgs),
+
     #[command(subcommand)]
     Install(InstallCmd),
 
@@ -59,6 +61,14 @@ pub enum Cmd {
     Ping,
 }
 
+/// Serve the bundled Sift CLI user documentation over HTTP.
+#[derive(clap::Args)]
+pub struct DocArgs {
+    /// Address the documentation HTTP server binds to.
+    #[arg(long, default_value_t = Self::default_addr())]
+    pub addr: SocketAddr,
+}
+
 /// Install optional Sift tooling such as autocompletions or Agent skills
 #[derive(Subcommand)]
 pub enum InstallCmd {
@@ -500,3 +510,9 @@ pub struct ImportHdf5Args {
     #[arg(long, help_heading = "One-d schema options")]
     pub time_name: Option<String>,
 }
+
+impl DocArgs {
+    fn default_addr() -> SocketAddr {
+        "0.0.0.0:3000".parse().unwrap()
+    }
+}

rust/crates/sift_cli/src/cmd/doc.rs

@@ -0,0 +1,30 @@
+use anyhow::{Context, Result};
+use axum::Router;
+use include_dir::{Dir, include_dir};
+use std::process::ExitCode;
+use tokio::net::TcpListener;
+use tower_serve_static::ServeDir;
+
+use crate::cli::DocArgs;
+
+static STATIC_ASSETS: Dir<'_> = include_dir!("$CARGO_MANIFEST_DIR/assets/docs/book");
+
+pub async fn serve(args: DocArgs) -> Result<ExitCode> {
+    let DocArgs { addr } = args;
+
+    let docs = ServeDir::new(&STATIC_ASSETS);
+
+    let router = Router::new().fallback_service(docs);
+
+    let ln = TcpListener::bind(addr)
+        .await
+        .context("failed to bind socket address")?;
+
+    println!("documentation available at tcp://{addr}");
+
+    axum::serve(ln, router)
+        .await
+        .context("server exited due to error")?;
+
+    Ok(ExitCode::SUCCESS)
+}

rust/crates/sift_cli/src/cmd/mod.rs

@@ -5,6 +5,7 @@ use std::{fs::read_to_string, io::ErrorKind};
 use toml::{Table, Value};
 
 pub mod config;
+pub mod doc;
 pub mod export;
 pub mod import;
 pub mod install;

rust/crates/sift_cli/src/main.rs

@@ -63,6 +63,7 @@ fn run(clargs: cli::Args) -> Result<ExitCode> {
             ConfigCmd::Where => return cmd::config::config_where(),
             ConfigCmd::Update(args) => return cmd::config::update(clargs.profile, args),
         },
+        Cmd::Doc(args) => return run_future(cmd::doc::serve(args)),
         Cmd::Install(cmd) => match cmd {
             InstallCmd::Completions(cmd) => match cmd {
                 cli::CompletionsCmd::Print(args) => return cmd::install::completions::print(args),