Initial commit

2025-04-09 09:34:15 +02:00
commit c19fb93ec5
47 changed files with 5174 additions and 0 deletions
@@ -0,0 +1,109 @@
+# Edison Installation Guide
+
+This guide covers how to install Edison on different operating systems.
+
+## Prerequisites
+
+Before installing Edison, ensure you have:
+
+- Python 3.6 or higher
+- pip (Python package manager)
+- An OpenAI API key
+
+## Installation Process
+
+```mermaid
+flowchart LR
+    A[Get Repository] --> B[Install Dependencies]
+    B --> C[Configure API Key]
+    C --> D[Test Installation]
+    
+    style A fill:#f9d5e5,stroke:#333,stroke-width:2px
+    style B fill:#eeeeee,stroke:#333,stroke-width:2px
+    style C fill:#d3f6db,stroke:#333,stroke-width:2px
+    style D fill:#d3f6f5,stroke:#333,stroke-width:2px
+```
+
+### Linux and macOS
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/user/command-assistant
+   cd command-assistant
+   ```
+
+2. Run the installation script:
+   ```bash
+   source install_edison.sh
+   ```
+
+   This script will:
+   - Create a virtual environment
+   - Install required dependencies
+   - Set up the Edison command
+
+3. Configure your OpenAI API key using one of these methods:
+   - Environment variable: `export OPENAI_API_KEY=<yourkey>`
+   - Create a file at `~/.openai.apikey` with just the key
+   - Add the key to the `edison.yaml` configuration file
+
+### Windows
+
+1. Clone the repository:
+   ```powershell
+   git clone https://github.com/user/command-assistant
+   cd command-assistant
+   ```
+
+2. Run the installation script:
+   ```powershell
+   .\install_edison.bat
+   ```
+
+3. Configure your OpenAI API key using one of these methods:
+   - Environment variable: `$env:OPENAI_API_KEY="<yourkey>"`
+   - Create a file at `~/.openai.apikey` with just the key
+   - Add the key to the `edison.yaml` configuration file
+
+## Manual Installation
+
+If you prefer to install manually:
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/user/command-assistant
+   cd command-assistant
+   ```
+
+2. Create and activate a virtual environment:
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+3. Install the package:
+   ```bash
+   pip install -e .
+   ```
+
+4. Configure your OpenAI API key as described above
+
+## Verifying Installation
+
+To test your installation, run:
+
+```bash
+edison what is the current time
+```
+
+You should see a command generated that displays the current time.
+
+## Troubleshooting
+
+If you encounter issues during installation:
+
+- Ensure Python 3.6+ is installed and in your PATH
+- Check that your OpenAI API key is correctly set
+- Verify that all dependencies were installed correctly
+
+See the [Troubleshooting](troubleshooting.md) page for more detailed help.