Dirvana

Dirvana is a versatile CLI tool designed to simplify the management of project-specific shell environments. With Dirvana, users can automatically load shell aliases, functions, and environment variables tailored to specific directories whenever they use the cd command. This approach eliminates the need to clutter global configurations such as .bashrc with project-specific settings and ensures a clean environment every time users switch directories.

Key Features

• Automatic Configuration Loading: Dirvana reads the .dirvana.yml file upon entering a directory and dynamically loads the corresponding settings, making project configurations instantly accessible.
• Effortless Cleanup: When exiting a directory, Dirvana automatically unloads the configurations, ensuring that the user's shell environment remains pristine without manual intervention.
• Fast Performance: Designed for efficiency, Dirvana introduces less than 10 milliseconds of overhead, with intelligent caching to optimize performance.
• Security Protocols: An authorization system is in place to ensure that only trusted configurations are loaded, providing explicit user consent for dynamic environment variables.
• Hierarchical Configuration: Settings can be inherited from parent directories, allowing for streamlined management of complex project configurations.
• Compatibility: Works seamlessly with Bash and Zsh, making it suitable for a wide range of users.
• User-Friendly Structure: Configurations are defined in a simple YAML format, bolstered by JSON Schema validation for error checking and auto-completion support.
• Enhanced Auto-completion: Inherits completion from aliased commands, improving user experience with command suggestions (for commands like git, kubectl, etc.).

Example Configuration

A typical configuration in the .dirvana.yml file may look like this:

aliases:
  tf:
    command: task terraform --
    completion: terraform  # Inherits terraform's auto-completion!
  plan: task terraform -- plan
  apply: task terraform -- apply

functions:
  greet: |
    echo "Hello, $1!"

env:
  GIT_REPOSITORY:
    sh: git remote get-url origin | sed 's/.*github.com:\(.*\)\.git/\1/'
  PROJECT_NAME: myproject
  TF_LOG: debug

Workflow Illustration

The workflow of how Dirvana operates can be visualized as follows:

• Entering a directory (cd ~/projects/myapp): Dirvana performs a series of checks, reads the configuration file, and merges it with any relevant global settings. If authorized, it will load the necessary aliases, functions, and environment variables.
• Exiting a directory: Upon exiting the directory, all loaded configurations are automatically unloaded to maintain a clean environment.

Conclusion

Dirvana streamlines the workflow for developers managing multiple projects by automating the management of shell configurations. This tool not only enhances productivity but also maintains clarity in the command line environment, making it an essential utility for anyone working with various coding projects.