Skip to content

Getting Started

paredit ships as a single binary. Nix is the primary distribution channel; Cargo works anywhere a Rust toolchain is available.

Run without installing (Nix)

nix run github:nerima-lisp/paredit-cli -- inspect check --file source.lisp

The companion lint and format gates are exposed as flake apps:

nix run github:nerima-lisp/paredit-cli#lint -- .
nix run github:nerima-lisp/paredit-cli#format -- --check .

Install into a Nix profile

nix profile install github:nerima-lisp/paredit-cli

Prebuilt binaries are published to the public takeokunn-paredit-cli Cachix cache, so neither command has to compile the crate from source:

cachix use takeokunn-paredit-cli

Use as a flake input

Add the flake and pick the packages or the overlay:

{
  inputs.paredit-cli.url = "github:nerima-lisp/paredit-cli";

  outputs = { nixpkgs, paredit-cli, ... }: {
    # Directly as a package:
    #   paredit-cli.packages.${system}.default
    # Or through the overlay, which provides pkgs.paredit-cli,
    # pkgs.paredit-lint, pkgs.paredit-format, and pkgs.paredit-format-files:
    #   nixpkgs.overlays = [ paredit-cli.overlays.default ];
  };
}

The flake also exports lib.${system}.mkLintCheck, mkFormatCheck, and treefmtFormatter for wiring structural checks into another project's nix flake check — see Integrations.

Install with Cargo

cargo install --git https://github.com/nerima-lisp/paredit-cli --locked

The minimum supported Rust version is 1.85 (edition 2024).

Pin automation

The examples above follow the latest default branch. For CI, production automation, or a reproducible developer environment, pin a release tag:

nix run github:nerima-lisp/paredit-cli/v1.4.0 -- --help
nix profile install github:nerima-lisp/paredit-cli/v1.4.0
cargo install --git https://github.com/nerima-lisp/paredit-cli --tag v1.4.0 --locked

A tag is the release artifact — the crate is not published to a package registry. For the strongest guarantee, pin an immutable commit instead and replace <commit> with a full commit SHA that you have reviewed:

nix run github:nerima-lisp/paredit-cli/<commit> -- --help
nix profile install github:nerima-lisp/paredit-cli/<commit>
cargo install --git https://github.com/nerima-lisp/paredit-cli --rev <commit> --locked

When upgrading a pin, inspect the release notes and compare the machine-readable command catalog before accepting the new revision:

paredit inspect capabilities --output json

Verify

paredit --help
paredit inspect --help

Run one task

Check a file's structure, format it, and rename a symbol across it:

paredit inspect check --file source.lisp
paredit edit format --file source.lisp
paredit refactor rename-symbol --file source.lisp --from old-name --to new-name

inspect is read-only. edit writes to stdout by default — add --diff for a unified diff, or --write to update the file in place. refactor is the planned, previewable path for semantic changes; see the refactor workflow.

Next steps