cmdy 0.1.4

Lists and runs predefined command snippets
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

# 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
- `edit` subcommand: open a snippet's source file in your `$EDITOR`
- `clip` subcommand: copy a snippet's command to the system clipboard

## Install

Requires Rust and [cargo].

```sh
cargo install cmdy
```

## Quickstart

1. Create a snippets directory (default location is `$XDG_CONFIG_HOME/cmdy/commands` or `~/.config/cmdy/commands`).
2. Add one or more `.toml` files with snippet definitions (see _Defining Snippets_ below).
3. Run:
   ```sh
   cmdy
   ```
4. Type to filter, select a snippet, and press Enter to execute it.

### Subcommands

- `cmdy edit` — Launch your `$EDITOR` on the selected snippet's TOML file.
- `cmdy clip` — Copy the selected snippet's `command` string 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 with `fzf` and `gum` (PRs welcome for other filtering tools).

## 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`:

```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:

```toml
[[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:

```sh
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.

## Release Process

```sh
# patch, or minor, or major
cargo release patch --no-publish --execute
git push --follow-tags
```


## License

Distributed under the MIT License. See [LICENSE] for details.

[fzf]: https://github.com/junegunn/fzf
[cargo]: https://doc.rust-lang.org/cargo/
[LICENSE]: LICENSE