Skip to content

Installation

📥 Installation GuideLink

Get Sierra Dev up and running on your system in minutes.

🎯 Quick InstallationLink

Copy-Paste Friendly

These commands will get you started. We'll explain what each does below!

Bash
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# Navigate to where you want Sierra
cd ~/Projects  # or your preferred directory

# Clone the repository
git clone https://github.com/xsyncio/sierra-dev
cd sierra-dev

# Create virtual environment
python3 -m venv venv
source venv/bin/activate

# Install Sierra Dev
pip install -e .

# Verify installation
sierra-dev --help
PowerShell
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# Navigate to where you want Sierra  
cd C:\Projects  # or your preferred directory

# Clone the repository
git clone https://github.com/xsyncio/sierra-dev
cd sierra-dev

# Create virtual environment
python -m venv venv
venv\Scripts\activate

# Install Sierra Dev
pip install -e .

# Verify installation
sierra-dev --help
Bash
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Create conda environment
conda create -n sierra python=3.10
conda activate sierra

# Clone and install
git clone https://github.com/xsyncio/sierra-dev
cd sierra-dev
pip install -e .

# Verify
sierra-dev --help

📋 PrerequisitesLink

Before installing, make sure you have:

RequiredLink

Requirement Minimum Version Check Command
Python 3.10+ python --version
pip 20.0+ pip --version
Git 2.0+ git --version
  • Text Editor - VS Code, PyCharm, or any code editor
  • Terminal - Comfortable with command line basics

🔍 Detailed Installation StepsLink

Step 1: Install PythonLink

Do I have Python installed?

Run python --version or python3 --version in your terminal.

  • ✅ Shows Python 3.10.x or higher → You're good!
  • ❌ Command not found → Install Python below
Bash
1
2
sudo apt update
sudo apt install python3 python3-pip python3-venv
Bash
1
2
# Using Homebrew
brew install python@3.10
  1. Download from python.org
  2. Run installer
  3. ✅ Check "Add Python to PATH"
  4. Click Install

Step 2: Install GitLink

Bash
1
sudo apt install git
Bash
1
2
# Using Homebrew
brew install git

Download from git-scm.com

Step 3: Clone Sierra DevLink

Bash
1
2
3
4
5
6
7
# Choose a location (examples)
cd ~/Projects          # macOS/Linux
cd C:\Projects         # Windows

# Clone the repository
git clone https://github.com/xsyncio/sierra-dev
cd sierra-dev

What This Does: - Downloads Sierra Dev source code - Creates a sierra-dev/ folder - Changes into that folder

Step 4: Create Virtual EnvironmentLink

Why Virtual Environment?

Keeps Sierra's dependencies separate from your system Python. This prevents conflicts and makes everything cleaner!

Bash
1
2
python3 -m venv venv  # Linux/macOS
python -m venv venv   # Windows

Activate it:

Bash
1
source venv/bin/activate

You should see (venv) in your terminal prompt.

Text Only
1
venv\Scripts\activate
PowerShell
1
venv\Scripts\Activate.ps1

If you get an error about execution policy:

PowerShell
1
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Step 5: Install Sierra DevLink

With your virtual environment activated:

Bash
1
pip install -e .

What This Does: - Installs Sierra Dev in "editable" mode (-e) - Installs all required dependencies - Makes sierra-dev command available

This will install: - Core Sierra framework - Package manager - CLI tools - All dependencies (httpx, beautifulsoup4, etc.)

Step 6: Verify InstallationLink

Bash
1
sierra-dev --help

You should see:

Text Only
1
2
3
4
5
6
7
8
9
usage: sierra-dev [-h] {init,clean,build,check,health,repo,search,info,install,update,upgradable,remove,list} ...

Sierra Dev - Invoker Package Manager

positional arguments:
  {init,clean,build,check,health,repo,search,info,install,update,upgradable,remove,list}
    init                Initialize a new project
    build               Build and compile invokers
    ...

✅ Success! Sierra Dev is installed.

🎨 Post-Installation SetupLink

Optional: Add to System PATHLink

If you want to use sierra-dev from any directory without activating venv:

Add to ~/.bashrc or ~/.zshrc:

Bash
1
export PATH="$PATH:$HOME/Projects/sierra-dev/venv/bin"

Then reload:

Bash
1
source ~/.bashrc  # or ~/.zshrc

  1. Search "Environment Variables" in Start Menu
  2. Click "Environment Variables"
  3. Under "User variables", select Path → Edit
  4. Add New: C:\Projects\sierra-dev\venv\Scripts
  5. Click OK on all dialogs

Create Your First EnvironmentLink

Bash
1
sierra-dev init my_first_project

This creates:

Text Only
1
2
3
4
my_first_project/
├── scripts/       # Your invoker source code goes here
├── config.yaml    # Auto-generated configuration
└── source         # Package source metadata

🔧 TroubleshootingLink

Common IssuesLink

Command not found: sierra-dev

Problem: Sierra Dev not in PATH or venv not activated

Solutions:

  1. Make sure virtual environment is activated:

    Bash
    1
2
    source venv/bin/activate  # Linux/macOS
venv\Scripts\activate     # Windows

  2. Or use full path:

    Bash
    1
2
    ./venv/bin/sierra-dev  # Linux/macOS
venv\Scripts\sierra-dev # Windows

Python version too old

Problem: ERROR: Python 3.10 or higher required

Solution: Install Python 3.10+

Check current version:

Bash
1
python --version

Install newer version and recreate venv:

Bash
1
python3.10 -m venv venv

Permission denied

Problem: Don't have write access

Solutions:

  1. Don't use sudo with pip (bad practice)
  2. Install in your home directory instead
  3. Use virtual environment (recommended)
ModuleNotFoundError: No module named 'sierra'

Problem: Imported sierra in wrong context

Solution:

  1. Make sure you're in the venv:

    Bash
    1
    which python  # Should show venv path

  2. Reinstall if needed:

    Bash
    1
    pip install -e .

git: command not found

Problem: Git not installed

Solution: Install Git (see Step 2 above)

SSL Certificate Error

Problem: Corporate proxy or firewall

Solution:

  1. Use --trusted-host:

    Bash
    1
    pip install -e . --trusted-host pypi.org --trusted-host files.pythonhosted.org

  2. Or configure proxy:

    Bash
    1
2
    export HTTP_PROXY=http://proxy.company.com:8080
export HTTPS_PROXY=http://proxy.company.com:8080

Getting More HelpLink

Enable Debug ModeLink

For detailed installation logs:

Bash
1
pip install -e . --verbose
Check DependenciesLink

List installed packages:

Bash
1
pip list

Should include: - sierra-dev (installed in editable mode) - httpx - beautifulsoup4 - dnspython - And more...

Verify Python EnvironmentLink
Bash
1
python -c "import sierra; print(sierra.__version__)"

Should print version number (e.g., 2.0.0)

🔄 Updating Sierra DevLink

Pull latest changes and reinstall:

Bash
1
2
3
cd sierra-dev
git pull
pip install -e . --upgrade

🗑️ UninstallingLink

Remove Sierra Dev:

Bash
1
pip uninstall sierra-dev

Remove entire directory:

Bash
1
2
3
cd ..
rm -rf sierra-dev  # Linux/macOS
rmdir /s sierra-dev  # Windows

✅ Verification ChecklistLink

Make sure everything works:

  • sierra-dev --help shows help message
  • sierra-dev init test creates a project
  • python -c "import sierra" runs without error
  • Virtual environment activates successfully

🚀 Next StepsLink

Now that Sierra Dev is installed:

  1. Learn Core Concepts - Understand how it all works
  2. Quick Start Tutorial - Build your first invoker
  3. CLI Reference - Master all commands

🎉 Installation Complete!

Start Building →