tinymist/crates/tinymist-cli
Myriad-Dreamin ef08eaa93b
Some checks failed
tinymist::auto_tag / auto-tag (push) Has been cancelled
tinymist::ci / Duplicate Actions Detection (push) Has been cancelled
tinymist::ci / Check Clippy, Formatting, Completion, Documentation, and Tests (Linux) (push) Has been cancelled
tinymist::ci / Check Minimum Rust version and Tests (Windows) (push) Has been cancelled
tinymist::ci / prepare-build (push) Has been cancelled
tinymist::gh_pages / build-gh-pages (push) Has been cancelled
tinymist::ci / announce (push) Has been cancelled
tinymist::ci / build (push) Has been cancelled
feat: enhance CLI and argument documentation (#2072)
This PR improves the help message of the CLL. Also, we change the verbs
in the help message from plural (e.g. `compiles`) to singular (e.g.
`compile`). This matches the style of `clap-rs`.

Added tests about critical help messages.
2025-09-03 17:02:42 +08:00
..
src feat: enhance CLI and argument documentation (#2072) 2025-09-03 17:02:42 +08:00
Cargo.toml feat: add js transport to sync-ls (#2029) 2025-08-12 06:07:23 +08:00
dist.toml fix: rename tinymist-cli artifacts back to tinymist (#2030) 2025-08-12 05:29:03 +08:00
README.md feat: move and compile tinymist crate for wasm32 target (#2027) 2025-08-11 13:14:26 +08:00

tinymist

This crate provides a CLI that starts services for Typst [taɪpst]. It provides:

  • tinymist probe: Do nothing, which just probes that the binary is working.
  • tinymist lsp: A language server following the Language Server Protocol.
  • tinymist preview: A preview server for Typst.
  • tinymist --help Learn more about the CLI.

Usage

See Features: Command Line Interface.

Documentation

See Crate Docs.

Also see Developer Guide: Tinymist LSP.

Contributing

See CONTRIBUTING.md.