Skip to content

README.md

Latest commit

 

History

History
51 lines (38 loc) · 1.52 KB

README.md

File metadata and controls

51 lines (38 loc) · 1.52 KB

ZAP CLI

Welcome to Zap CLI! This command-line interface (CLI) tool is designed to provide a wide range of useful scripts and commands for various tasks. This repository features a collection of tools and utilities, all accessible through an intuitive and extensible CLI interface, making it easy to integrate into your daily workflows.

Installation Guide

To get started with zap-cli, follow these steps:

1. Clone the Repository

First, clone the repository to your local machine:

git clone https://github.com/arsalan-dev-engineer/zap-cli.git

2. Navigate to the Project Directory

Change to the project directory:

cd zap-cli

3. Make the Setup Script Executable

Make the setup.sh script executable:

chmod +x setup.sh

4. Run the Setup Script

Run the setup.sh script to set up the environment:

./setup.sh

The script will:

  • Install the required dependencies (Python, virtual environment tools).
  • Create and activate a Python virtual environment.
  • Install the dependencies listed in requirements.txt.
  • Set up zap-cli.py as a global command.

5. After Installation

Once the script has completed, load your updated PATH (or open a new terminal), then run zap-cli from any directory:

source ~/.bashrc   # or close and reopen your terminal
zap-cli

Notes:

Ensure that bash is installed on your system to run the setup script. The setup script will create a virtual environment in the project folder and install all dependencies listed in requirements.txt.