installation.md

Requirements

• Python 3.8 or higher
• Git repository

Install from PyPI

pip install goal

Install from Source

git clone https://github.com/wronai/goal.git
cd goal
pip install -e .

Development Installation

git clone https://github.com/wronai/goal.git
cd goal
pip install -e ".[dev]"

This installs additional development dependencies:

• pytest - for testing
• build - for building packages
• twine - for publishing to PyPI

Verify Installation

goal --version
## Optional Dependencies

Goal works out of the box, but you might want these for specific features:

### For Python Projects
```bash
pip install pytest black isort flake8

For Node.js Projects

npm install -g
### Bash
```bash
eval "$(_GOAL_COMPLETE=bash_source goal)"

Add to ~/.bashrc for permanent completion:

echo 'eval "$(_GOAL_COMPLETE=bash_source goal)"' >> ~/.bashrc

Zsh

eval "$(_GOAL_COMPLETE=zsh_source goal)"

Add to ~/.zshrc for permanent completion:

echo 'eval "$(_GOAL_COMPLETE=zsh_source goal)"' >> ~/.zshrc

Fish

eval (env _GOAL_COMPLETE=fish_source goal)

Using Goal in Docker

FROM python:3.11-slim

WORKDIR /app
COPY . .

# Install Goal
RUN pip install goal

# Set up entrypoint
ENTRYPOINT ["goal"]
CMD ["--help"]

Pre-built Docker Image

docker run --rm -v $(pwd):/app -w /app wronai/goal:latest push

Permission Denied

If you get a permission error, you might need to install with user permissions:

pip install --user goal

Make sure ~/.local/bin is in your PATH:

echo 'export PATH=$PATH:~/.local/bin' >> ~/.bashrc
source ~/.bashrc

Git Not Found

Goal requires Git to be installed:

# Ubuntu/Debian
sudo apt-get install git

### Python Version

Check your Python version:

```bash
python --version
# Should be 3.8 or higher

If you have multiple Python versions:

python3 -m pip install goal

Next Steps

After installation:

1. Initialize your project
2. Configure Goal
3. Check examples