https://github.com/cjrh/acts
Small terminal menu to run preconfigured commands
https://github.com/cjrh/acts
command-line-interface command-runner terminal-based terminal-menu
Last synced: 11 months ago
JSON representation
Small terminal menu to run preconfigured commands
- Host: GitHub
- URL: https://github.com/cjrh/acts
- Owner: cjrh
- License: agpl-3.0
- Created: 2024-07-24T09:25:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-24T12:35:23.000Z (over 1 year ago)
- Last Synced: 2025-03-19T04:48:42.151Z (11 months ago)
- Topics: command-line-interface, command-runner, terminal-based, terminal-menu
- Language: Rust
- Homepage:
- Size: 22.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# acts
Small terminal menu to run commands.
## Demo
Given a configuration file like this:
```toml
# example_config.toml
[todaysdate]
name = "Today's date"
description = ""
command = "echo $(date)"
[listdir]
name = "List directory"
description = ""
command = "ls -lah"
```
The program can be invoked like this:
```bash
$ eval "$(acts example_config.toml)"
```
And then first you will see this menu displayed in your terminal:
```
acts
use wasd, jk, or arrow keys
enter to select, q or esc to exit
-----------------------
> List directory
Today's date
```
And when you select an option, the command will be executed
and then executed by your shell.
## Design Considerations
These are the design considerations:
- Commands should be executed by YOUR shell, not inside `acts`.
This decreases surface area for me to worry about, and ensures the
best cross-platform compatibility. My examples above are for `bash`,
but it should work with any shell as long as that shell can
distinguish between `stdout` and `stderr`, and has a way to `eval`
or otherwise execute a command.
- Different collections of commands for different circumstances.
That is what the toml config file is for. You can have different
config files for different projects, or different config files for
different parts of the same project. So the actions can be
customized for the situation.
- Few dependencies, the less the better. I use `std` to parse args
for example, instead of bigger libraries like `clap`. I would have
loved to use a config file format supported by `std` but there are
none, so I use `toml` which is a small dependency.
## Future plans
### justfile support
I would like to add `justfile` as a supported config file format.
In this case, I would just populate the menu with commands from
the `justfile` and execute them with `just`. A problem to be solved
is what to do with just commands that take parameters.
### npm's `package.json`
I would like to add support for `package.json` as a config file,
allowing you to run npm scripts from the menu.
## Dev workflow
While working on the Rust code, it can be invoked like this:
```bash
$ eval "$(cargo run -- example_config.toml)"
```