# eggl-cli

> eggl-cli is a small command-line toolkit for development, Kubernetes, and everyday workflows.

## Others

- [eggl cd](/commands/cd.md): Resolve a configured directory alias and print its path.
- [Diagnostics and Metadata](/commands/diagnostics.md)
- [eggl empty](/commands/empty.md): Create an empty Git commit. This is useful for retriggering a CI pipeline without changing tracked files. The command runs in the current repository and reports the commit hash. With --push, the configured Git remote and credentials are used.
- [eggl env](/commands/env.md): Switch a Kubernetes context and Tailscale account as one named environment.
- [Command Reference](/commands/index.md): Run eggl --help for the top-level list or eggl <command> --help for the flags and examples for a command. The executable is eggl; the product is eggl-cli. All eggl-cli commands support the global --verbose flag. It sends operation details to stderr. Set NO_COLOR to disable interactive styling.
- [eggl kill](/commands/kill.md): Find processes listening on a local TCP port and terminate them.
- [eggl pf](/commands/pf.md): Run a configured Kubernetes port-forward using the active kubectl context.
- [eggl dedash and eggl eol](/commands/text-files.md): Both commands recursively scan text files and provide the same safety controls.
- [Shell Completion](/completion.md): eggl-cli generates completion scripts for Bash, Zsh, Fish, and PowerShell.
- [Config File](/configuration/config-file.md): The complete shape of the file is:
- [Directory Aliases](/configuration/directories.md): Directory aliases map short names to paths: List configured aliases: Resolve an alias: The command prints the path but cannot change the parent shell's working directory. Use command substitution: For a shorter command, define a shell function:
- [Configuration](/configuration/index.md): eggl-cli keeps profiles, port-forwards, and directory aliases in one YAML file. The default path is: When XDG_CONFIG_HOME is set, eggl-cli uses $XDG_CONFIG_HOME/eggl/config.yaml instead. Every configuration-aware command also accepts --config to use a different file. The file must contain at least one profile or directory. Port-forwards are optional.
- [Port-forwards](/configuration/port-forwards.md): Named port-forwards use the active Kubernetes context: resource accepts Kubernetes kinds such as svc, service, deployment, pod, statefulset, daemonset, job, and cronjob. If ports is omitted, eggl-cli uses 8080:80.
- [Environment Profiles](/configuration/profiles.md): An environment profile pairs a Kubernetes context with a Tailscale account: The account value can be an account ID, tailnet name, or email from:
- [Development](/development.md): eggl-cli keeps command orchestration separate from domain behavior.
- [Install](/install.md): Choose the distribution channel that fits your machine.
- [Quickstart](/quickstart.md): This walkthrough creates two environment profiles, a named port-forward, and a directory alias.
- [Releasing](/releasing.md): Releases are created by pushing a version tag. The release workflow runs GoReleaser after generating notes with Git Cliff.
- [Troubleshooting](/troubleshooting.md): Start with:
- [Workflows](/workflows.md): These recipes combine eggl with the tools it already uses.