Skip to content

installation.md

Latest commit

 

History

History
78 lines (53 loc) · 1.5 KB

installation.md

File metadata and controls

78 lines (53 loc) · 1.5 KB
Raw

Installation Guide

This guide walks through installing and running Forge CLI locally.

Requirements

  • Python 3.10 or later
  • Git
  • A terminal with network access to clone from GitHub

Check your Python version:

python3 --version

Install from source

  1. Clone the repository:
git clone https://github.com/ForgeCoders/forge-cli.git
cd forge-cli
  1. (Optional) Create and activate a virtual environment:
python3 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
  1. Run the CLI entrypoint:
python3 src/main.py

You should see:

Welcome to Forge CLI!
Build. Learn. Share.

Usage examples

Show the welcome banner:

python3 src/main.py

From another directory (after cloning):

python3 /path/to/forge-cli/src/main.py

Verify the install

python3 -c "import pathlib; p=pathlib.Path('src/main.py'); assert p.exists(); print('ok:', p.resolve())"

Troubleshooting

Problem What to try
python: command not found Use python3 instead of python.
Wrong Python version Install Python 3.10+ and confirm with python3 --version.
Clone fails Check GitHub access and that the repo URL is correct.
Script prints nothing unexpected Confirm you are in the repo root or pass an absolute path to src/main.py.

Next steps