Skip to content

Development

For developers and contributors. See the full Development Guide for details.

Manual Installation

  • Clone the repo:
    git clone https://github.com/Lusan-sapkota/smart-shell.git
    cd smart-shell
    
  • Set up a virtual environment:
    python3 -m venv venv
    source venv/bin/activate
    pip install -e .
    
  • Set your API key:
    export SMART_SHELL_API_KEY=your-api-key-here
    

Contributing

  • Please read CONTRIBUTING for guidelines.
  • Issues and PRs are welcome!

Project Structure

  • smart_shell/: Main source code
  • docs/: Documentation
  • examples/: Usage examples
  • install.sh: Installer script
  • requirements.txt, pyproject.toml: Dependencies

See API Reference for code-level documentation.