lucide-svg-rs

A Lucide Library and Offline CLI

lucide-svg-rs is a Rust library + command-line tool for working with Lucide SVG icons both online and offline. All icons are shipped in a local icons/ directory — no network access required.

🚀 Quick Start

Installation

Clone and build:

cargo build --release

The binary will be available at:

target/release/lucide-svg-rs

📖 Usage

List icons

lucide-svg-rs list
lucide-svg-rs list --json

Search icons

lucide-svg-rs search alert
lucide-svg-rs search alert --json

Export icons

lucide-svg-rs download-all ./out

🧪 Testing

Run the test suite:

cargo test

This covers:

• Defaulting to ICONS_DIR
• Searching icons
• Download/export
• JSON output validity

🧑‍💻 Developer Guide

For a comprehensive reference covering:

• Integration & JSON tests (cargo test --test cli)
• Examples & doctests
• CI/CD workflows
• Release automation (checksums, GPG signing, SBOM)
• Reproducible builds (Nix flake)
• Portable usage (Docker)

👉 see GUIDE.md.

🤝 Contributing

We welcome contributions! Please read CONTRIBUTING.md for guidelines.

Key points:

• Follow Conventional Commits (e.g. feat:, fix:, docs:)
• Our release process is automated via Release Please — version bumps and CHANGELOG are handled for you
• Ensure cargo fmt, cargo clippy -D warnings, and cargo test all pass before opening a PR

📚 Docs build

CI verifies the docs compile cleanly (warnings as errors):

RUSTDOCFLAGS="-D warnings" cargo doc --no-deps

🚦 Publish guard

On tags (v*.*.*), CI runs a publish guard to catch issues before a real publish:

• cargo package --locked
• cargo publish --dry-run
• docs.rs-style build on nightly with --cfg docsrs -D warnings

📦 crates.io publish

A separate workflow .github/workflows/cargo-publish.yml runs when a GitHub Release is published.

• Requires CARGO_REGISTRY_TOKEN secret (from crates.io account)
• Only runs on the main repository (not forks)
• Executes cargo publish --locked

🔗 Unified Release Flow

Releases are handled by a single workflow (.github/workflows/release.yml) that:

• plans/builds via cargo-dist
• generates an aggregate CHECKSUMS.sha256 (and optional .asc signature)
• produces a CycloneDX SBOM
• publishes a GitHub Release with all artifacts

Trigger by pushing a tag:

git tag v0.1.0
git push origin v0.1.0

🚀 Releases

Maintainers: use the Release Checklist issue form to guide each release. Tag format: vX.Y.Z (e.g., v0.1.0).

• Open a new issue → Release Checklist

• Complete pre-tag checks, then tag and push:

  git tag v0.1.0
  git push origin v0.1.0
  

• CI will build artifacts, generate SBOM & checksums, publish GitHub Release, and (optionally) push Homebrew/Scoop files.

• A separate workflow can publish the crate to crates.io when a GitHub Release is published.

🔧 Note: CI/Release/Codecov badges are auto-patched by .github/workflows/patch-badges.yml after pushes to main.