Skip to content

usage.md

Latest commit

 

History

History
136 lines (87 loc) · 3.62 KB

usage.md

File metadata and controls

136 lines (87 loc) · 3.62 KB

Peck Package Manager Usage Guide

This document provides a comprehensive guide on how to use the peck command-line interface to manage Pome packages.

Installation

Before using peck, ensure it is installed on your system. You can build and install peck using the provided install.sh script:

git clone https://github.com/Pomilon/Peck
cd Peck
chmod +x install.sh
./install.sh

Commands

peck install <package_source>

Installs a Pome package. Packages can be sourced from the official Peck package index, a direct Git repository URL, or a local file system path.

Options:

  • --global: Installs the package into the system-wide global Pome environment (/usr/local/lib/pome/modules/). By default, packages are installed into your project's virtual environment (.pome_env/lib/) or ~/.pome/modules/ if no virtual environment is detected.
  • --editable: (Only for local path installations) Creates a symbolic link to the package source, allowing live changes to be reflected without re-installation.

Examples:

  1. Install from the official index:

    peck install my_package
peck install my_package==1.0.0 # Install a specific version

  2. Install from a Git repository URL:

    peck install git+https://github.com/USERNAME/my_repo.git
peck install git+https://github.com/USERNAME/my_repo.git@main # Install from a specific branch
peck install git+https://github.com/USERNAME/my_repo.git@v1.0.0 # Install from a specific tag
peck install git+https://github.com/USERNAME/my_repo.git@a1b2c3d4e5f6... # Install from a specific commit hash

Note: Installing from direct Git URLs bypasses the verified commit hash security of the official index. A warning will be displayed.

  1. Install from a local path:

    peck install ./path/to/my_local_package

  2. Install from a local path in editable mode:

    peck install --editable ./path/to/my_local_package

peck uninstall <package_name>

Uninstalls an installed Pome package.

Options:

  • --global: Uninstalls from the system-wide global environment.

Example:

peck uninstall my_package
peck uninstall --global system_package

peck update [package_name]

Updates installed Pome packages.

  • If package_name is provided, only that specific package will be checked for updates and upgraded if a newer version is available in the index.
  • If package_name is omitted, peck will check all currently installed packages for updates.

Options:

  • --global: Updates packages in the system-wide global environment.

Examples:

peck update my_package       # Update a specific package
peck update                  # Update all packages in the current environment
peck update --global         # Update all packages in the global environment

peck search <keyword>

Searches the official Peck package index for packages matching the provided keyword.

Example:

peck search util
peck search networking

peck list

Lists all Pome packages installed in the current environment.

Options:

  • --global: Lists packages installed in the system-wide global environment.

Example:

peck list         # List packages in the current environment
peck list --global # List packages in the global environment

peck init

Interactively guides you through the process of creating a pome_pkg.json metadata file in the current directory, defining a new Pome package.

Example:

peck init

peck --help

Displays the help message with a list of commands and options.

peck --help