This project has been archived by its maintainers, and is no longer receiving any updates.
socrates-cli
Command-line interface for the Socrates AI platform. Interact with Socrates through an easy-to-use CLI tool.
Overview
socrates-cli provides a unified command-line interface to the Socrates platform. It communicates with the Socrates API server, making it perfect for:
- Local development and testing
- CI/CD pipelines
- Scripting and automation
- Interactive exploration
Installation
Via pip
pip install socrates-cli
With Full Platform
pip install socrates-ai # Includes CLI, API, and all libraries
From Source
git clone https://github.com/themsou/Socrates.git
cd Socrates/socrates-cli
pip install -e .
Quick Start
Initialize Socrates
# Initialize with API server
socrates init
# Or specify API URL explicitly
socrates init --api-url http://localhost:8000
Create a Project
socrates project create \
--name "My Project" \
--owner "your-username" \
--description "A sample project"
List Projects
socrates project list
# With formatting
socrates project list --format json
Generate Code
# Generate code for a project
socrates code generate \
--project-id proj_xxxxx \
--prompt "Create a REST API"
# Save to file
socrates code generate \
--project-id proj_xxxxx \
--prompt "Create a REST API" \
--output generated_code.py
System Information
# Check connection and system info
socrates info
# Check API server health
socrates health
Environment Variables
Configure the CLI with environment variables:
# API Server
export SOCRATES_API_URL=http://localhost:8000
export SOCRATES_API_PORT=8000
# Authentication (if required)
export SOCRATES_API_KEY=your-api-key
# Logging
export SOCRATES_LOG_LEVEL=INFO
Commands Reference
Project Management
socrates project create
Create a new project.
socrates project create \
--name "Project Name" \
--owner "username" \
--description "Optional description"
Options:
--name(required): Project name--owner(required): Project owner--description: Project description
socrates project list
List all projects.
socrates project list
# JSON output
socrates project list --format json
# Filter by owner
socrates project list --owner username
Options:
--format: Output format (table, json) - default: table--owner: Filter by owner
socrates project get
Get project details.
socrates project get --project-id proj_xxxxx
Options:
--project-id(required): Project ID
socrates project delete
Delete a project.
socrates project delete --project-id proj_xxxxx
# With confirmation
socrates project delete --project-id proj_xxxxx --yes
Options:
--project-id(required): Project ID--yes,-y: Skip confirmation prompt
Code Generation
socrates code generate
Generate code for a project.
socrates code generate \
--project-id proj_xxxxx \
--prompt "Create a REST API for user management"
Options:
--project-id(required): Project ID--prompt(required): Code generation prompt--output,-o: Save to file--format: Output format (text, json)
socrates code analyze
Analyze generated code.
socrates code analyze \
--project-id proj_xxxxx \
--code-id code_xxxxx
Options:
--project-id(required): Project ID--code-id(required): Code ID
System Information
socrates init
Initialize CLI configuration.
socrates init
# Specify API server
socrates init --api-url http://localhost:8000
socrates info
Display system information.
socrates info
socrates health
Check API server health.
socrates health
socrates version
Display CLI version.
socrates version
Configuration
Configuration File
The CLI creates a configuration file at:
- Linux/macOS:
~/.socrates/config.json - Windows:
%APPDATA%\socrates\config.json
Example configuration:
{
"api_url": "http://localhost:8000",
"api_key": "your-api-key",
"timeout": 30,
"output_format": "table",
"log_level": "INFO"
}
Configuration Precedence
- Command-line arguments (highest)
- Environment variables
- Configuration file
- Default values (lowest)
Using with API Server
The CLI requires a running Socrates API server:
# Terminal 1: Start API server
socrates-api
# Terminal 2: Use CLI
socrates project create --name "My Project" --owner "user"
Standalone Mode (Optional)
For quick testing without a separate API server:
# Install with standalone support
pip install socrates-cli[standalone]
# Use directly (no API server needed)
socrates project create --name "My Project" --owner "user" --standalone
Output Formats
Table Format (default)
socrates project list
Output:
ID Name Owner Created
proj_abc123 My Project user 2024-01-15
proj_def456 Another One user 2024-01-16
JSON Format
socrates project list --format json
Output:
[
{
"id": "proj_abc123",
"name": "My Project",
"owner": "user",
"created_at": "2024-01-15T10:30:00Z"
}
]
Error Handling
The CLI provides clear error messages:
# Connection refused
socrates info
Error: Cannot connect to API server at http://localhost:8000
Suggestion: Start API server with 'socrates-api'
# Invalid project ID
socrates project get --project-id invalid
Error: Project not found
Scripting Examples
Bash Script
#!/bin/bash
# Create project
PROJECT=$(socrates project create \
--name "Auto-Generated" \
--owner "bot" \
--format json)
PROJECT_ID=$(echo $PROJECT | jq -r '.id')
# Generate code
socrates code generate \
--project-id $PROJECT_ID \
--prompt "Create a Python function" \
--output function.py
echo "Code saved to function.py"
Python Script
import subprocess
import json
# Create project
result = subprocess.run([
'socrates', 'project', 'create',
'--name', 'MyProject',
'--owner', 'bot',
'--format', 'json'
], capture_output=True, text=True)
project = json.loads(result.stdout)
project_id = project['id']
# Generate code
subprocess.run([
'socrates', 'code', 'generate',
'--project-id', project_id,
'--prompt', 'Create a REST API',
'--output', 'api.py'
])
Troubleshooting
"Cannot connect to API server"
# Check if API server is running
socrates health
# Start API server
socrates-api
# Specify custom API URL if needed
export SOCRATES_API_URL=http://your-server:8000
socrates info
"Invalid API key"
# Set API key
export SOCRATES_API_KEY=your-api-key
# Or add to config file
~/.socrates/config.json
"Command not found"
# Reinstall CLI
pip install --upgrade socrates-cli
# Or install from source
pip install -e .
Performance Tips
- Use JSON format for scripting:
--format json - Batch operations when possible
- Cache API responses when appropriate
- Use pagination for large result sets
Support
- Documentation: See docs/
- Issues: GitHub Issues
- API Documentation: http://localhost:8000/docs (when API running)
Contributing
Contributions are welcome! See the main Socrates repository for guidelines.
License
MIT - see LICENSE for details
Metadata
Release files for socrates-cli 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| socrates_cli-0.1.1.tar.gz | 19.0 kB | Without provenance | Details for socrates_cli-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| socrates_cli-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for socrates_cli-0.1.1-py3-none-any.whl |
Total release size: 31.2 kB
Release files / socrates_cli-0.1.1.tar.gz
| Download URL | socrates_cli-0.1.1.tar.gz |
|---|---|
| Size | 19.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fa00a92094e96279bcd4043dd026dc2c1f10bed2b6897bc35a7a2024ea4b9e94
|
|
BLAKE2b-256 checksum How to use checksums |
ab06011cb8cd1bcdf454ca38f5c70ad20c42fb32c65c63790b4b62b191763195
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Release files / socrates_cli-0.1.1-py3-none-any.whl
| Download URL | socrates_cli-0.1.1-py3-none-any.whl |
|---|---|
| Size | 12.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2e9c7424bb7e5f441cc059789579bc665659503539b7d0917ff03c5f3aed6d53
|
|
BLAKE2b-256 checksum How to use checksums |
5effcea3b92d757d38fd9a20ffdd166f1424dfaf05900878c1cb268f8a79cbab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Security for socrates-cli 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.