5 releases
new 0.1.5 | Jan 8, 2025 |
---|---|
0.1.4 |
|
0.1.3 | Jun 22, 2024 |
#543 in Command line utilities
176 downloads per month
16KB
123 lines
clamshell
A quick and dirty to-do file viewer and manipulator.
Installation and Build
Clone the repository and navigate into it:
git clone https://github.com/DriftingOtter/clamshell.git
cd clamshell
Set the environment variable for your to-do file and build the project:
export TODO_FILE_PATH=/home/USERNAME_HERE/Documents/todo.org
cargo build --release
Optional: Move Binary to Local Binaries Folder
To access clamshell
without specifying the binary path, move it to your local binaries folder:
cp target/release/clamshell ~/.local/bin
Ensure ~/.local/bin
is in your PATH
. You can add it by updating your shell configuration file (~/.bashrc
or ~/.zshrc
):
export PATH="$HOME/.local/bin:$PATH"
Synopsis
- View mode:
clamshell
- Edit mode:
clamshell -e
orclamshell --edit
- Help mode:
clamshell -h
orclamshell --help
Additional Arguments
--editor <name>
: Specifies the editor to use (e.g., vim, nano). Defaults tonano
.--viewer <name>
: Specifies the viewer to use (e.g., cat, less). Defaults tocat
.
Authors
- Daksh Kaul // DriftingOtter 🦦