Official Python library to interact with Forktex API
Project description
Forktex Python CLI 🚀
Forktex is the official Python CLI & SDK for interacting with the Forktex API.
It enables developers and teams to call AI models, manage cloud resources, and integrate Forktex services directly from the terminal or Python scripts.
✨ Features
- 🤖 AI models — call Forktex-hosted AI models with simple CLI commands
- ☁️ Cloud resource management — create, manage, and monitor Forktex cloud resources
- 🛠️ Developer-friendly — designed for automation, CI/CD, and scripting
- 📦 PyPI-ready — install & upgrade via pip
📦 Installation
pip install forktex
Upgrade to the latest version anytime:
pip install --upgrade forktex
🚀 Quickstart (CLI)
After installation, the forktex CLI is available globally:
forktex --help
Example: Call an AI model
forktex ai call --model ro-hero --prompt "Hello, world!"
Example: Manage cloud resources
forktex cloud list
forktex cloud create --type vm --name test-vm
⚙️ Configuration
You’ll need an API key from the Forktex Dashboard.
Set it as an environment variable:
export FORKTEX_API_KEY="your_api_key_here"
Or configure via CLI:
forktex config set api_key your_api_key_here
📖 Usage as a Python Library
You can also use Forktex as a Python SDK:
from forktex import Client
client = Client(api_key="your_api_key")
# Call an AI model
result = client.ai.call(model="ro-hero", prompt="Hello world!")
print(result.output)
# List cloud resources
resources = client.cloud.list()
print(resources)
🤝 Contributing
Contributions are welcome!
- Open issues and feature requests at GitHub Issues
- Submit PRs to improve the library and CLI
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file forktex-0.1.3.tar.gz.
File metadata
- Download URL: forktex-0.1.3.tar.gz
- Upload date:
- Size: 1.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b4e5130641cfe257cb480935c3bb369430cfd3a6108de0a827ec163ce1d07276
|
|
| MD5 |
b42b919b524816fee193b2fb2eace49d
|
|
| BLAKE2b-256 |
01fbc862fdb78b4c2a24899fb67fc4ef5e227f0c0d279892184892fe32de37ac
|
File details
Details for the file forktex-0.1.3-py3-none-any.whl.
File metadata
- Download URL: forktex-0.1.3-py3-none-any.whl
- Upload date:
- Size: 2.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1bd32f56ee083fe61ea981e09a0d11e0cbebacbac21a4e44e0f366c9637d54f4
|
|
| MD5 |
03357c349a34ecfbf7c3ba324a6577a7
|
|
| BLAKE2b-256 |
4f83d5d6c2d19df9663248b6ce7eab6f73282681cc0f2119b499fa438692923a
|