8 releases
Uses new Rust 2024
| 0.2.1 | Dec 1, 2025 |
|---|---|
| 0.2.0 | Dec 1, 2025 |
| 0.1.6 | Oct 25, 2025 |
| 0.1.0 | May 10, 2025 |
#361 in Command line utilities
44KB
927 lines
cmdy
A simple CLI tool to manage, select, and execute predefined shell command snippets.
Features
- Define command snippets in TOML files and organize them in directories
- Interactive fuzzy search using fzf (with ANSI colors, reversed layout, rounded border, 50% height by default)
- Filter snippets by tags
- Run snippets directly from the selection menu
editsubcommand: open a snippet's source file in your$EDITORclipsubcommand: copy a snippet's command to the system clipboard
Install
Requires Rust and cargo.
cargo install cmdy
Quickstart
- Create a snippets directory (default location is
$XDG_CONFIG_HOME/cmdy/commandsor~/.config/cmdy/commands). - Add one or more
.tomlfiles with snippet definitions (see Defining Snippets below). - Run:
cmdy - Type to filter, select a snippet, and press Enter to execute it.
Subcommands
cmdy edit— Launch your$EDITORon the selected snippet's TOML file.cmdy clip— Copy the selected snippet'scommandstring to your clipboard.
Flags
--dir <DIRECTORY>— Specify a custom snippets directory (overrides default).-t, --tag <TAG>— Show only snippets tagged with<TAG>(can be repeated).-q, --query <QUERY>— Pre-populate the initial filter query for the interactive selector. This works withfzfandgum(PRs welcome for other filtering tools).--dry-run— Show the command that would be executed without actually running it. Useful for verifying commands before execution.
Configuration
Global settings are loaded from cmdy.toml in your config directory ($XDG_CONFIG_HOME/cmdy/cmdy.toml or ~/.config/cmdy/cmdy.toml).
Example cmdy.toml:
# Command used for interactive filtering
filter_command = "fzf --ansi --layout=reverse --border=rounded --height=50%"
# Additional snippet directories to scan
directories = ["/path/to/other/snippets"]
Defining Snippets
Create one or more .toml files in your snippets directory, using the [[commands]] table:
[[commands]]
description = "List all files with details"
command = "ls -lAh --color=auto"
tags = ["files", "list"]
[[commands]]
description = "Show current date and time"
command = "date '+%Y-%m-%d %H:%M:%S'"
Files without valid [[commands]] tables are skipped, and duplicate description names across files will error.
Development
Clone the repo and build:
git clone https://github.com/markjaquith/cmdy.git
cd cmdy
cargo build
cargo test
Ensure you have fzf installed in your PATH for interactive selection.
Development Commands
# Run tests
cargo test
# Run linting
cargo clippy
# Format code
cargo fmt
# Run with debug output
RUST_LOG=debug cargo run
# Build release version
cargo build --release
# Check for security vulnerabilities
cargo audit
Project Structure
cmdy/
├── src/ # Source code
│ ├── main.rs # Entry point and CLI parsing
│ ├── config.rs # Configuration management
│ ├── types.rs # Data structures
│ ├── loader.rs # TOML file loading
│ ├── ui.rs # User interface and selection
│ └── executor.rs # Command execution
├── tests/ # Integration tests
├── examples/ # Example command files
├── .github/ # CI/CD workflows
└── Cargo.toml # Project manifest
Release Process
# patch, or minor, or major
cargo release patch --no-publish --execute
git push --follow-tags
If a release fails CI on GitHub, delete the tag and retry:
git tag -d v0.1.X
git push origin :v0.1.X
# Fix the issue, then re-release
License
Distributed under the MIT License. See LICENSE for details.
Dependencies
~5–23MB
~297K SLoC