CyborgShell - Documentation

Quick Navigation

New to CyborgShell? Start here:

⚙️ configuration-guide.html (Optional - only needed for AI features)
⚙️ configuration-proxy.html (Optional - only needed for some AI features)
📚 getting-started.html (5 min read)
📚 session-management.html (Session management deep dive)
📚 quick-reference.html
📚 dags.html
📚 project-creation-guide.html
📚 api-guide.html

For Security/IT Teams:

🔒 executive-summary.html (One-page overview for decision makers)
🔒 architecture-security.html (Architecture, privacy, compliance, deployment)
🔒 cyborgshell-vs-rag.html

Core Features ✨

**AI Integration:** Seamless, multi-provider AI access (Gemini, ChatGPT, Claude, Ollama)
**Air-Gap Capable:** Run self-hosted with Ollama for zero external data transfer
**Open Source:** MIT License, full code auditability, and zero vendor lock-in
**Pipeline Automation:** Declarative AI/data pipelines that auto-execute on file change
**BASIC/JS Hybrid:** Use 80s BASIC syntax with modern JavaScript power
**Cross-Platform:** Works identically on phone, tablet, PC, or game console
**No Platform Fees:** You only pay your AI provider

            The Open Source Advantage (MIT License)
            Audit all code for security
Modify for your needs
Deploy anywhere (internal, cloud, air-gapped)
No vendor lock-in or usage fees
Full control

        

Support & Community

If you have any questions, you can always find help:

Type help in CyborgShell for built-in command reference.
Visit cyborgshell.com for the official site.
Check the source code and file issues on GitHub.

Documentation Files

For Security/IT Teams

executive-summary.html

The Security Model
Deployment Models
Compliance Benefits
Cost Analysis
Technical Requirements
Risk Assessment
Implementation Path
Competitive Analysis
Decision Criteria

architecture-security.html

Architecture Design
Security Model
The CORS Proxy
Deployment Scenarios
Compliance & Enterprise
Technical Details
Security Best Practices
Advantages of This Architecture
Source Code and Open Source License
Conclusion

Key Security Features

✅ Code runs in browser (client-side execution)
✅ API keys in browser local storage (never sent to servers) *
✅ Direct API calls to providers (no intermediary) *
✅ Self-hostable (MIT License: github.com/PrimalNinja/cyborgshell)
✅ Air-gap capable (self-host + Ollama = zero external data)
✅ CORS proxy fully auditable (~200 lines PHP, included in repo)
✅ Coming Soon: ZOSCII Information Theoretic Security (ITS) Encoding for local storage

* unless you use the Cyborg Shell's optional CORS proxy server

For Developers/Users

configuration-guide.html

Overview (Configuration is Optional!)
When Configuration is Needed
Accessing csconfig
Configuration Options
AI Service Setup (OpenAI, Claude, Gemini, Ollama)
Provider Configuration
Backup and Deployment
Advanced Configuration
Security Considerations
Troubleshooting
Complete Examples

configuration-proxy.html

When the Proxy is Needed
Proxy Configuration Settings
Proxy Options
How jsonbearer Works
Proxy Security Configuration
Complete Examples
Troubleshooting
Security Best Practices
Air-Gap Deployment

getting-started.html

Why It's Different
Two Ways to Code
Essential Commands
AI in 4 Ways
Your First Program
Your First AI Pipeline

session-management.html

Session Architecture
Interactive Session Usage
Session Management Commands
Training Sessions (Building Knowledge Bases)
Transformer Session Usage
Complete Pipeline Examples
Best Practices
Advanced Patterns
Troubleshooting
Session Files Format
Integration with Other Features
Summary

quick-reference.html

Philosophy
Architecture and Security
Configuration
Execution Modes
Command Aliases
AI Features
Project Setup
File Management
Linking (Create Pipelines)
Project Management
Dirty Flags and Saving
Transformers
Common Patterns
Workflow Examples
Debugging
Tips
Remember
Quick Start

dags.html

What is a DAG
Traditional DAG Tools vs CyborgShell
How CyborgShell Works
Live Example: 2 Minutes
Real-World Examples
Why This Architecture Matters
The Key Insight
CyborgShell: Redefining DAG Orchestration

project-creation-guide.html

Project File structure
Key Concepts
Available Transformers
Design Patterns
Example Projects
Command-Line Project Creation
Best Practices
Common Patterns
Debugging Tips
Advanced Techniques
File Formats
Tips for AI Prompts
Session Management in Pipelines
Additional Example Projects
Conclusion

api-guide.html

Application Types
Screen and Output Functions
File Functions
Data/Database Functions
Utility Functions
Tab Functions
Complete Examples