3 releases (breaking)
0.3.0 | Sep 19, 2024 |
---|---|
0.2.0 | Sep 17, 2024 |
0.1.0 | Sep 17, 2024 |
#34 in Configuration
98 downloads per month
23KB
388 lines
pono - pack and organize symlinks once
pono (poh-no to place/store in latin) is a cli for managing symbolic links in one place inspired by stow
. Because symbolic links managment in bash script sucks.
Why?
Let's face it, managing symbolic links with bash scripts sucks because ln
has poor defaults. The alternative GNU stow does almost what I wanted, but not quite. I wanted a tool that could manage symlinks for multiple packages independent of the source file structure, using a flat configuration. I also need to be able to toogle links on demand to apply different configs.
Demo
Create the pono.toml
in the current directory
[ponos]
nvim = { source = "./examples/from/nvim", target = "./examples/to/nvim" }
zsh = { source = "./examples/from/zshrc", target = "./examples/to/.zshrc" }
And run
pono enable -c example/pono.toml
Linking packages
nvim: ./examples/to/nvim (new link)
zsh: ./examples/to/.zshrc (new link)
ls -la examples/to [1:00:35]
total 0
drwxr-xr-x 4 cris 128 Sep 14 01:00 .
drwxr-xr-x 5 cris 160 Sep 14 01:00 ..
lrwxr-xr-x 1 cris 58 Sep 14 01:00 .zshrc -> /home/cris/pono/./examples/src/zshrc
lrwxr-xr-x 1 cris 57 Sep 14 01:00 nvim -> /home/cris/pono/./examples/src/nvim
cr
Features
- Declarative symlink management with a simple TOML configuration file.
- Create, remove, and check symlinks for multiple packages at once.
- Customizable target directories for each package.
- Check the status of symlinks to detect broken links.
Future features
- Supports pattern matching for including or excluding files.
- Built-in dry-run mode to preview changes before applying them.
- Verbose mode for detailed output.
- Manage same link with diffrent source and toogle between them.
Table of Contents
Installation
With Cargo
You can install pono using Cargo:
cargo install pono
With Nix
You can install pono using Nix:
nix profile install github:cristianoliveira/pono#pono
After Installation
Enable pono completions for your shell by adding the following to your shell configuration file:
if command -v pono &> /dev/null; then
eval "$(pono completions)" ## or $(pono completions <shell>)
fi
Check pono --help
for more information.
Usage
The pono CLI allows you to install, remove, and check symlinks based on a TOML configuration file.
Commands
enable
: Create symbolic links for the defined ponos.disable
: Remove symbolic links for the defined ponos.toggle
: Toggle a given ponoa and verify.status
: Check the status the define ponos.list
: Display all available ponos from the TOML configuration.
Options
-c --config <file>
: Specify a custom TOML configuration file (default:./pono.toml
).--help
: Display help information.
Basic Usage
Enabling symlinks (ponos)
To create symlinks for all packages defined in pono.toml
:
pono enable
To enable symlinks for specific packages:
pono enable package1 package2
Disabling symlinks (ponos)
To remove symlinks for all packages:
pono disable
To disable specific packages:
pono disable package1
Checking Symlink Status
To check the status of all symlinks:
pono status
# OR
pono status package1 package2
Listing All Packages
To list all available packages from the TOML configuration:
pono list
Help
For more detailed command usage, run:
pono --help
Configuration
The configuration is defined in a pono.toml
file. It specifies the source directories for your packages and where the symlinks should be created.
Example pono.toml
:
[ponos.package1]
source = "path/to/package1"
target = "/usr/local/bin"
[ponos.package2]
source = "path/to/package2"
target = "/home/user/.config"
[ponos.package3]
source = "path/to/package3"
target = "/opt/tools"
Fields:
- source: The directory containing the files to be linked.
- target: The directory where the symlinks should be created.
Contributing
Building from Source
To build the project from source, you will need to have Rust installed on your system. You can then clone the repository and build the project using Cargo:
cargo build --release
Running Tests
To run the test suite, you can use the following command:
cargo test
Code Formatting
The project uses rustfmt
for code formatting. You can run the following command to format the code:
cargo fmt
License
pono is licensed under the MIT License.
Dependencies
~1.6–2.3MB
~44K SLoC