https://github.com/rostrovsky/na
Nested aliases for your shell
https://github.com/rostrovsky/na
aliases bash command-line commandline-tool fish fish-shell na nested nested-alias nested-aliases powershell shell sodium terminal-based zsh
Last synced: about 2 months ago
JSON representation
Nested aliases for your shell
- Host: GitHub
- URL: https://github.com/rostrovsky/na
- Owner: rostrovsky
- License: mit
- Created: 2023-10-13T07:57:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-31T20:45:45.000Z (over 1 year ago)
- Last Synced: 2025-01-22T14:12:00.533Z (4 months ago)
- Topics: aliases, bash, command-line, commandline-tool, fish, fish-shell, na, nested, nested-alias, nested-aliases, powershell, shell, sodium, terminal-based, zsh
- Language: Go
- Homepage:
- Size: 5.62 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sodium
**N**ested **a**liases for your shell.
## Quick start
1. Install `na`
```shell
go install github.com/rostrovsky/na@latest
```
...or download binary from the [releases page](./releases) and put it somewhere in your `$PATH`.
1. Set up your aliases in [config file](#config-file).
1. Generate autocompletions for your shell:
* bash
```shell
source <(na completion bash)
```
* zsh
```shell
source <(na completion zsh)
```
* powershell
```shell
Register-ArgumentCompleter -CommandName na -ScriptBlock $__naCompleterBlock
na completion powershell | Out-String | Invoke-Expression
```
* fish
```shell
na completion fish | source
```
1. Use it!
```shell
na # and then press Tab ↹ as many times as you need
```
## Config file
### Config file schema
#### Minimal form
```yaml
# minimal form config example
aliases:
ssh:
dev:
host-x: ssh user@host-x
host-y: ssh user@host-y
prod:
host-a: ssh user@host-a
host-b: ssh user@host-b
grep:
heron: grep -hEron --with-filename --color=always
```
#### Full form
Compared to the minimal form, in the full form:
* you must add mandatory `_cmd` key which contains aliased command
* you can add optional `_info` key that enriches autocompletion hints with description.
```yaml
# full form config example
aliases:
ssh:
_info: aliases for SSH connections
dev:
_info: DEV environments aliases
host-x:
_info: makes ssh connection to host X on DEV env
_cmd: ssh user@host-x
host-y:
_info: makes ssh connection to host Y on DEV env
_cmd: ssh user@host-y
prod:
_info: PROD environments aliases
host-a:
_info: makes ssh connection to host A on PROD env
_cmd: ssh user@host-a
host-b:
_info: makes ssh connection to host B on PROD env
_cmd: ssh user@host-b
grep: # _info key is completely optional though recommended
heron:
_cmd: grep -hEron --with-filename --color=always
```
### Config file location
By default, `na` expects configuration file placed in `~/.config/sodium/.narc.yaml` (or `.yml`).
You can override default config file location by setting `SODIUM_CONFIG` environment variable.
## Supported shells
`na` supports all [cobra](https://github.com/spf13/cobra)-generated autocompletions:
* bash
* fish
* powershell
* zsh
## Reserved aliases
Below aliases cannot be used due to being [cobra](https://github.com/spf13/cobra) bultins:
* `completion`
* `help`
* `--help`
* `-h`
* any alias starting with underscore `_`
## Debug logs
If you need to see the debug logs, set `SODIUM_LOG_LEVEL` env variable to `debug` (case insensitive).
## License
MIT