This is a Python client for the TODO for AI service that runs as a background task. It connects to the server, authenticates, and handles file operations and shell script execution requests.
- WebSocket connection to TODO for AI server
- Authentication with email/password
- Automatic reconnection logic
- File system operations (directory listing)
- Shell script execution
- Heartbeat mechanism to maintain connection
Download the appropriate file for your system:
- Windows: todoforai-edge.exe
- macOS: todoforai-edge-mac
- Linux: todoforai-edge-linux
For more information, visit our download page.
pip install todoforai-edgegit clone https://github.com/todoforai/edge.git
cd edge
pip install -e .By default, TODO for AI Edge starts with a graphical user interface for easy authentication and monitoring:
# Simply run the client to start the UI
todoforai-edgeThe UI provides:
- Authentication via email/password or API key
- Client status monitoring
- Start/stop controls for the client
For automation or headless environments, you can run the client from the command line:
# Using email/password authentication
todoforai-edge --no-ui --email your@email.com --password yourpassword
# Using an existing API key
todoforai-edge --no-ui --apikey your-api-keyYou can also set the following environment variables:
TODO4AI_EMAIL&TODO4AI_PASSWORD: Your email & password for default authenticationTODO4AI_API_KEY: If you already have an API key, you can provide it directly
TODO for AI supports a custom URL protocol that allows you to start the client directly from a web browser. This is useful for authentication and quick access to the application. Use:
First, register the protocol handler:
todoforai-edge --register-protocolThis only needs to be done once per machine.
You can use the following URL formats:
- Authenticate with an API key:
todoforai://auth/apikey/YOUR_API_KEY_HERE
You can add links to your website that will launch the TODO for AI client:
<a href="todoforai://auth/apikey/YOUR_API_KEY_HERE">Start TODOforAI Client</a>For security reasons, you might want to generate these links dynamically with user-specific API keys.
TODO for AI Edge includes a simple graphical user interface for authentication and monitoring the client:
# Launch the client with the UI
todoforai-edgeThe UI provides:
- Authentication via email/password or API key
- Client status monitoring
- Start/stop controls for the client
This is especially useful for users who prefer not to use the command line.
We'd love to hear from you! If you're using TodoForAI in your projects or organization, please consider dropping us a quick note at marcellhavlik@todofor.ai.
Hearing about your use cases helps us:
- Improve the product based on real-world usage
- Prioritize features that matter to our community
- Connect with users who might benefit from upcoming features
This is completely optional and not required by our license, but your feedback is incredibly valuable to our small team!
MIT License with Notification Request - see the LICENSE file for details.