Skip to content

galax-io/galaxio-cli

Repository files navigation

galaxio-cli

CI Coverage Latest Release Go Report Card License

galaxio is the command-line interface for Galaxio workflows.

This is the initial version of the CLI. It includes help, version output, shell completion, and stable exit codes for scripts and CI.

Install

Install the latest version with Go:

go install github.com/galax-io/galaxio-cli/cmd/galaxio@latest

Install a tagged release binary:

curl -fsSL https://raw.githubusercontent.com/galax-io/galaxio-cli/main/scripts/install.sh | sh
GALAXIO_VERSION=0.1.1 sh scripts/install.sh

The installer writes to $HOME/.local/bin by default. Add it to PATH if needed:

export PATH="$HOME/.local/bin:$PATH"

Or download a prebuilt binary from the GitHub Releases page.

Usage

Show available commands and flags:

galaxio --help

Print build information:

galaxio version
galaxio --version

Control diagnostic output:

galaxio --verbose version
galaxio --quiet version
galaxio --no-color version

Generate shell completion:

galaxio completion bash
galaxio completion zsh
galaxio completion fish
galaxio completion powershell

Example zsh install:

mkdir -p ~/.zsh/completion
galaxio completion zsh > ~/.zsh/completion/_galaxio

Update galaxio from GitHub Releases:

galaxio update
galaxio update --dry-run
galaxio update --version 0.1.1

Local template examples and manifest format notes live in docs/templates/README.md and examples/templates/.

Exit Codes

galaxio keeps exit codes stable for scripts and CI:

Code Meaning
0 Command completed successfully.
1 Runtime failure while executing a valid command.
2 Usage error such as invalid flags, arguments, or commands.

Build From Source

Clone the repository and build the binary:

git clone https://github.com/galax-io/galaxio-cli.git
cd galaxio-cli
go build -o bin/galaxio ./cmd/galaxio

Run the test suite:

go test ./...

License

This project is distributed under the terms described in LICENSE.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors