tealdeer/README.md

tldr-rs

An implementation of tldr in Rust.

Project goals:

• Don't require a network connection for anything besides updating the cache
• Render tldr pages to ANSI terminals
• Download and cache pages, compatible to the NodeJS client
• Command line interface similar or equivalent to the NodeJS client
• Be fast

Building

Debug build with logging enabled:

$ cargo build --features logging

Release build without logging:

$ cargo build --release

To enable the log output, set the RUST_LOG env variable:

$ export RUST_LOG=tldr=debug

License

MIT