agent-template-rust

This repository provides a Copier template for starting new Rust projects. Running Copier with this template generates a fresh crate preconfigured with sensible defaults and continuous integration.

The template requires Copier 9.0 or later to avoid incompatibilities.

How to use

1. Install Copier 9.0 or later: pip install copier.
2. Run copier copy gh:leynos/agent-template-rust <destination>.
3. Fill in the prompts for project, crate, license, and nightly toolchain date.
4. Change into the created directory and start coding.

What you get

• Cargo setup using the 2024 edition and Clippy's pedantic lint level enabled【F:template/Cargo.toml†L1-L9】.
• Pinned toolchain file specifying a configurable nightly release 【F:template/rust-toolchain.toml.jinja†L1-L3】.
• Project metadata prompts for repository URL, homepage, crates.io keywords, crates.io categories, nightly date, and optional Linux development target.
• Fast generated tooling including Cranelift debug code generation, Linux mold linking for development builds, cargo-nextest tests with a cargo-test fallback, Whitaker linting, and a lld-backed coverage target.
• Starter code providing either a binary entry point or a library function depending on flavour【F:template/src/{% if flavour == APP %}main.rs{% else %}lib.rs{% endif %}.jinja†L1-L10】.
• GitHub CI workflow that formats, lints, tests, and uploads coverage metrics to CodeScene【F:template/.github/workflows/ci.yml†L1-L35】.
• Release workflow for cross-platform binaries when the app flavour is used 【F:template/.github/workflows/{% if flavour == APP %}release.yml{% endif %}.jinja†L1-L114】.
• Markdownlint configuration applying consistent line length rules 【F:template/.markdownlint-cli2.jsonc†L1-L11】.
• Codecov settings requiring 80% patch coverage and a small project threshold【F:template/codecov.yml†L1-L8】.
• ISC license template ready for your details【F:template/LICENSE†L1-L9】.
• Starter README referencing Copier for regeneration【F:template/README.md†L1-L3】.

Use this template when you need a minimal scaffold for CLI tools or small utilities. The included workflow ensures coverage metrics are collected and linters run from the very first commit.

Testing

Install the test requirements and run pytest to ensure the template renders correctly using pytest-copier. Additional details are in docs/testing.md.

User-facing generated-project behaviour is documented in docs/users-guide.md. Parent-template development requirements are documented in docs/developers-guide.md.