Documentation on Dirvana

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Installation Guide#

Prerequisites#

Dirvana works with:

Bash (4.0+)
Zsh (5.0+)
Fish (3.0+)
Linux, macOS, or WSL

Method 1: Using Aqua (Recommended)#

If you use aqua, add this to your aqua.yaml:

registries:
- type: standard
 ref: v4.223.0 # renovate: depName=aquaproj/aqua-registry

packages:
 - name: NikitaCOEUR/dirvana@vX.Y.Z  # replace X.Y.Z with the desired version

Then run:

aqua install --link-only

Method 2: Using go install#

If you have Go installed (1.21+):

go install github.com/NikitaCOEUR/dirvana/cmd/dirvana@latest

Method 3: Download Binary#

Linux#

curl -L https://github.com/NikitaCOEUR/dirvana/releases/latest/download/dirvana-linux-amd64 -o /usr/local/bin/dirvana
chmod +x /usr/local/bin/dirvana

For ARM64:

Quick Start

Mon, 01 Jan 0001 00:00:00 +0000

Quick Start Guide#

Get started with Dirvana in 5 minutes!

Step 1: Create a Project Configuration#

Navigate to your project directory:

cd ~/projects/myproject

Initialize Dirvana (creates .dirvana.yml):

dirvana init

Step 2: Edit Configuration#

Open the configuration file:

dirvana edit

Or edit .dirvana.yml manually:

# Simple aliases
aliases:
 ll: ls -lah
 gs: git status
 build: go build -o bin/app ./cmd

# Aliases with auto-completion
aliases:
 k:
 command: kubectl
 completion: kubectl  # Now 'k <TAB>' works!

# Functions
functions:
 mkcd: |
 mkdir -p "$1" && cd "$1"

# Environment variables
env:
 PROJECT_NAME: myproject
 LOG_LEVEL: debug

 # Dynamic values
 GIT_BRANCH:
 sh: git rev-parse --abbrev-ref HEAD

Step 3: Authorize the Project#

For security, you must authorize each project:

Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Configuration Reference#

Complete reference for Dirvana configuration files.

Configuration Files#

Dirvana supports two types of configuration files:

Global config: ~/.config/dirvana/global.yml - Applied to all projects
Local configs: .dirvana.yml in project directories - Project-specific settings

Configuration files are merged in this order: global → root → parent → current directory (child configs override parent values).

Supported formats#

Local configs can be written in YAML, TOML or JSON. The first file found in this order wins: .dirvana.yml, .dirvana.yaml, .dirvana.toml, .dirvana.json. All examples in this documentation use YAML; see examples/ in the repository for the equivalent TOML and JSON files.

CLI Reference

Mon, 01 Jan 0001 00:00:00 +0000

CLI Reference#

All commands accept the global --log-level flag (debug, info, warn, error; also settable via DIRVANA_LOG_LEVEL). Print the version with dirvana --version.

Setup & hooks#

`dirvana setup`#

Automatically installs the shell hook for the detected shell (or --shell bash|zsh|fish). Use --uninstall / -u to remove it.

dirvana setup
dirvana setup --shell zsh
dirvana setup --uninstall

`dirvana hook`#

Prints the hook code for manual installation, if you prefer editing your RC file yourself.

Development

Mon, 01 Jan 0001 00:00:00 +0000

Development Guide#

Contributing to Dirvana.

Prerequisites#

Go 1.21 or later
Task - Build automation (install)
aqua (optional) - Dependency management (install)

Building#

# Build binary
task build

# Build with dev features (tracing support)
task build-dev

Binary will be in bin/dirvana. Multi-platform release builds are handled by GoReleaser (goreleaser release --snapshot --clean for a local dry run).

Testing#

# Run unit tests
task test

# Run tests with coverage
task test-coverage

# Run tests with verbose output
task test-verbose

# Run integration tests (Docker required)
task test-integration

# Run specific shell integration test
task test-integration-bash
task test-integration-zsh
task test-integration-fish

# Run all tests (unit + integration)
task test-all

Integration Tests#

Integration tests validate Dirvana in real shell environments using Docker:

Documentation on Dirvana

Installation

Installation Guide#

Prerequisites#

Method 1: Using Aqua (Recommended)#

Method 2: Using go install#

Method 3: Download Binary#

Linux#

Quick Start

Quick Start Guide#

Step 1: Create a Project Configuration#

Step 2: Edit Configuration#

Step 3: Authorize the Project#

Configuration

Configuration Reference#

Configuration Files#

Supported formats#

CLI Reference

CLI Reference#

Setup & hooks#

dirvana setup#

dirvana hook#

Development

Development Guide#

Prerequisites#

Building#

Testing#

Integration Tests#

`dirvana setup`#

`dirvana hook`#