Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0x15ba88ff/devault
Manage local projects and repositories
https://github.com/0x15ba88ff/devault
cli git github project python repository
Last synced: about 9 hours ago
JSON representation
Manage local projects and repositories
- Host: GitHub
- URL: https://github.com/0x15ba88ff/devault
- Owner: 0x15BA88FF
- License: gpl-3.0
- Created: 2024-10-12T14:48:39.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-01T10:27:26.000Z (11 days ago)
- Last Synced: 2025-01-01T11:27:14.611Z (11 days ago)
- Topics: cli, git, github, project, python, repository
- Language: Python
- Homepage:
- Size: 80.1 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Dev Vault
## Overview
Dev Vault is a minimal command-line tool designed to manage your Git repositories.
It provides functionality for initializing environments, organizing them into collections, and more.
## Features
- **Organize Repositories**: Clone and create repositories from various providers into your vault in a well-structured manner.
- **Find Repositories**: Search for repositories using regex patterns.
- **Group Repositories**: Organize repositories into collections for easier management.
- **Create Local Repositories**: Initialize a new local Git repository with starter content.
## Installation
### 1. UNIX Install Script
On UNIX operating systems, you can use the install script:
```bash
sh <(curl https://raw.githubusercontent.com/0x15BA88FF/devault/refs/heads/main/scripts/install.sh)
```
### 2. Build from Source
Alternatively, use a package builder like PyInstaller to build an executable from the source code:
```bash
git clone https://github.com/0x15BA88FF/devault.git
cd ./devault
pip install pyinstaller
pyinstaller --onefile --name devault --paths devault devault/__main__.py
```
## Uninstallation
### 1. UNIX Uninstall Script
On UNIX operating systems, you can use the uninstall script:
```bash
sh <(curl https://raw.githubusercontent.com/0x15BA88FF/devault/refs/heads/main/scripts/uninstall.sh)
```
### 2. Manual Removal
If installed via the UNIX install script, the binary will be in `/usr/bin`. Simply remove it:
```bash
sudo rm /usr/bin/devault
```
If you installed it elsewhere, remove it from the corresponding directory.
## Usage
### Command Line Interface
Interact with Dev Vault through the command line:
```bash
devault --help
devault --help
```
## Configuration
The tool uses an environment variable `DEVDIR` to define the base directory for managing repositories.
If this variable is not set, it defaults to `~/Dev`. Set it in your shell configuration file:
```bash
export DEVAULT_DIR="/path/to/your/dev/vault"
```
## Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to enhance the functionality of Dev Vault.
## License
This project is licensed under the GNU GENERAL PUBLIC LICENSE. See the [LICENSE](LICENSE) file for more information.