'Generic Commit'
This commit is contained in:
16
README.md
16
README.md
@ -1,6 +1,6 @@
|
||||
# getpkg - Package Manager for Dropshell Tools
|
||||
|
||||
getpkg is a command-line package manager that simplifies tool installation, management, and publishing for the dropshell ecosystem. Tools are installed to `~/.local/bin/getpkg/` and automatically added to your PATH with bash completion.
|
||||
getpkg is a command-line package manager that simplifies tool installation, management, and publishing for the dropshell ecosystem. Tools are installed to `~/.getpkg/` with executable symlinks in `~/.local/bin/getpkg/` and automatically added to your PATH with bash completion.
|
||||
|
||||
## Installation
|
||||
|
||||
@ -75,11 +75,12 @@ getpkg version
|
||||
When you install a tool, getpkg:
|
||||
|
||||
1. **Downloads** the tool archive from getpkg.xyz
|
||||
2. **Extracts** it to `~/.local/bin/getpkg/<tool_name>/`
|
||||
3. **Updates PATH** by modifying `~/.bashrc_getpkg`
|
||||
4. **Enables completion** for the tool
|
||||
5. **Runs setup** if a `setup_script.sh` exists
|
||||
6. **Stores metadata** in `~/.config/getpkg/<tool_name>.json`
|
||||
2. **Extracts** it to `~/.getpkg/<tool_name>/`
|
||||
3. **Creates symlinks** for all executables in `~/.local/bin/getpkg/`
|
||||
4. **Ensures PATH** includes `~/.local/bin/getpkg` (one-time setup)
|
||||
5. **Enables completion** for the tool
|
||||
6. **Runs setup** if a `setup_script.sh` exists
|
||||
7. **Stores metadata** in `~/.config/getpkg/<tool_name>.json`
|
||||
|
||||
### Architecture Support
|
||||
|
||||
@ -92,7 +93,8 @@ Tools are automatically downloaded for your architecture, with fallback to unive
|
||||
|
||||
### File Locations
|
||||
|
||||
- **Installed tools**: `~/.local/bin/getpkg/<tool_name>/`
|
||||
- **Tool files**: `~/.getpkg/<tool_name>/` (actual tool installation)
|
||||
- **Executable symlinks**: `~/.local/bin/getpkg/` (in your PATH)
|
||||
- **Configuration**: `~/.config/getpkg/`
|
||||
- **PATH setup**: `~/.bashrc_getpkg` (sourced by `~/.bashrc`)
|
||||
|
||||
|
Reference in New Issue
Block a user