documentation / installation
Install Ashplug
Ashplug is distributed as a Rust CLI. Install it from a source checkout, initialize configuration, then choose an AI provider.
Prerequisites
- Rust stable 1.85 or newer and Cargo.
- Bash or Zsh for shell integration.
- An OpenAI-compatible endpoint, local Ollama server, or mock provider.
Build from source
terminal
git clone https://github.com/XenVen/ashplug.git
cd ashplug
cargo install --path .Repository note: the project’s installation guide currently uses XenVen/ashplug, while the active Git remote is Ashplug/ashplug. Resolve that identity before publishing a canonical clone command.
Initialize and verify
configuration
ashplug --version
ashplug config init
ashplug config showShell integration
Print and source the integration without changing a startup file:
bash
ashplug init bash > /tmp/ashplug.bash
source /tmp/ashplug.bashFor Zsh, replace bash with zsh. Persistent setup uses the corresponding eval "$(ashplug init bash)" line in the shell startup file.