![\"Karnel](\"https://raw.githubusercontent.com/israelmarques1024-dotcom/karnel-termux/main/assets/images/karnel-logo.png\"){kind=logo}
\n\n \n
\n Transform your Android into a complete development workstation.\n
\n\n\n \n ![\"Version\"](\"https://img.shields.io/badge/version-4.17.43-0078D4?style=for-the-badge\"){kind=icon}
![\"npm\"](\"https://img.shields.io/npm/v/karnel-termux?style=for-the-badge&logo=npm&color=cb3837\")
![\"npm](\"https://img.shields.io/npm/dt/karnel-termux?style=for-the-badge&logo=npm&color=cb3837\")
![\"License\"](\"https://img.shields.io/badge/license-MIT-0078D4?style=for-the-badge\"){kind=icon}
![\"Platform\"](\"https://img.shields.io/badge/platform-Termux%20%7C%20Android-0078D4?style=for-the-badge\"){kind=icon}
![\"Website\"](\"https://img.shields.io/badge/Site-karneltermux.vercel.app-0078D4?style=for-the-badge\"){kind=icon}
` | Speech language: `pt-BR`, `en-US`, `es`, etc |\n| `--raw` | Skip editor, use raw capture |\n| `--no-clip` | Don't copy prompt to clipboard |\n\n### Flow\n\n```\nMicrophone -> termux-speech-to-text -> editor (edit) -> clipboard -> AI agent\n```\n\n1. Speak the prompt\n2. Review and correct in editor\n3. Prompt is copied to clipboard\n4. AI agent is dispatched with the prompt\n\n### Requirements\n\n- Termux:API: `pkg install termux-api`\n- App Termux:API: https://github.com/termux/termux-api\n- Editor (optional): `karnel install editor`; otherwise use `--raw` or the automatic raw fallback\n\n---\n\n## karnel pg — PostgreSQL\n\nManage PostgreSQL databases with simple commands:\n\n```bash\nkarnel pg init && karnel pg start # Initialize and start server\nkarnel pg create myapp # Create a database\nkarnel pg shell # Open psql console\n```\n\n---\n\n## karnel init — Project Templates\n\nConfigure existing projects in seconds:\n\n```bash\ncd my-next-app && karnel init next # Next.js + TypeScript + Tailwind\ncd my-api && karnel init express # Express + TypeORM\ncd backend && karnel init nest # NestJS + authentication\n```\n\n| Template | Description |\n|----------|-------------|\n| `next` | Next.js with webpack, TypeScript, Tailwind, React Query, Zustand |\n| `react` | React + Vite with modern structure |\n| `express` | Express API with TypeScript + TypeORM + migrations |\n| `nest` | NestJS with TypeORM and JWT auth |\n| `python` | FastAPI with SQLModel/SQLAlchemy |\n| `go` | Go with Gin or Fiber |\n| `rust` | Rust with Axum or Actix Web |\n\n---\n\n## karnel env\n\nManage environment variables securely:\n\n```bash\nkarnel env set # Add key (hidden input)\nkarnel env list # List variables\nkarnel env ls # List variables\n```\n\n---\n\n## karnel deploy\n\nRun an installed platform CLI through Karnel; arguments after the tool name are\nforwarded unchanged:\n\n```bash\nkarnel deploy vercel # Deploy to Vercel\nkarnel deploy railway # Deploy to Railway\nkarnel deploy netlify # Deploy to Netlify\nkarnel supabase doctor # Check Supabase CLI and project setup\nkarnel supabase link --project-ref # Link the current project\n```\n\nInstall a platform CLI first with `karnel install deploy --`.\n\n---\n\n## karnel open\n\nOpen documentation for any module in browser:\n\n```bash\nkarnel open ai # Open AI module docs\nkarnel open db # Open DB module docs\n```\n\nDocumentation loads from https://karneltermux.vercel.app.\n\n---\n\n## Documentation\n\n- [Documentation index](https://github.com/israelmarques1024-dotcom/karnel-termux/blob/main/docs/index.md)\n- [CLI reference](https://github.com/israelmarques1024-dotcom/karnel-termux/blob/main/docs/cli/index.md)\n- [Doctor reference](https://github.com/israelmarques1024-dotcom/karnel-termux/blob/main/docs/doctor/index.md)\n- [Troubleshooting](https://github.com/israelmarques1024-dotcom/karnel-termux/blob/main/docs/troubleshooting/index.md)\n- [Architecture](https://github.com/israelmarques1024-dotcom/karnel-termux/blob/main/docs/ARCHITECTURE/index.md)\n- [Documentation changelog](https://github.com/israelmarques1024-dotcom/karnel-termux/blob/main/docs/CHANGELOG.md)\n- [Official website](https://karneltermux.vercel.app)\n\n---\n\n## Examples\n\n```bash\n# Install databases\nkarnel install db --postgresql --sqlite\n\n# Install specific AI agents\nkarnel install ai --opencode --ollama --claude-code\n\n# View available tools\nkarnel list ai\n\n# View tool documentation\nkarnel show ai --opencode\n\n# Update everything\nkarnel update karnel\n\n# Reinstall a module\nkarnel reinstall shell\n\n# Full diagnosis\nkarnel doctor\n\n# Deploy directly\nkarnel deploy vercel\n```\n\n---\n\n## Project Structure\n\n```\nkarnel/\n├── karnel/\n│ ├── bin/ # Binary (karnel)\n│ ├── cli/\n│ │ ├── commands/ # CLI commands (install, list, show, etc.)\n│ │ └── karnel.sh # Main CLI (with TUI)\n│ ├── modules/ # Module orchestrators\n│ ├── tools/ # Tool installers\n│ │ ├── ai/ # 46 AI tools\n│ │ ├── lang/ # 8 languages\n│ │ ├── db/ # 5 databases\n│ │ ├── dev/ # 22 dev tools\n│ │ ├── editor/ # 3 editors\n│ │ ├── npm/ # 11 global npm packages\n│ │ ├── shell/ # 10 ZSH plugins\n│ │ ├── ui/ # 4 UI components\n│ │ ├── auto/ # 1 automation tool\n│ │ ├── network/ # 2 network tools\n│ │ ├── utils/ # 13 utility tools\n│ │ ├── games/ # 6 games\n│ │ ├── security/ # 30 security tools\n│ │ ├── osint/ # Robin OSINT (Tor + LLM)\n│ │ ├── voice/ # Speech-to-agent via Termux:API\n│ │ ├── plugins/ # Plugin manager\n│ │ └── deploy/ # 4 deploy CLIs\n│ └── utils/ # Utilities (banner, log, env, etc.)\n├── install.sh # Installation script\n├── package.json # npm/pnpm publishing\n└── .github/workflows/ # CI/CD\n```\n\n---\n\n## Configuration\n\n### Environment Variables\n\n```bash\nexport KARNEL_DEBUG=1 # Debug logs\n```\n\n### Directories\n\n| Directory | Description |\n|-----------|-------------|\n| `~/.local/share/karnel-data/` | Persistent tool data |\n| `~/.cache/karnel/` | Logs and cache |\n| `~/.config/karnel/` | User configuration |\n\n---\n\n## Automatic Updates\n\nThe framework checks for updates every 24 hours in background.\n\n```bash\nkarnel update karnel # Update the framework\n```\n\n`karnel update` requires a target such as `karnel`, `ai`, or `security`.\n`karnel update karnel` first runs the official curl installer, then falls back to\nthe local Git checkout if needed. Package-manager fallback is used only when the\nactive framework was installed by that package manager. The curl installer is\npinned to the latest GitHub release tag, and its SHA-256 checksum is verified\nbefore it runs. The framework checks for a new version in the background at most\nonce every 24 hours; the check can use npm or GitHub and writes state under\n`$KARNEL_CACHE`.\n\n---\n\n## Verification And Limits\n\nThe repository CI validates Bash/Zsh syntax, ShellCheck errors, CLI smoke tests,\nversion behavior, Robin contracts, plugin lifecycle contracts, and npm package\ncontents. The `Publish Docs` workflow builds the GitHub Pages documentation\nmirror with `actions/jekyll-build-pages`; the official Vite documentation site\nis built and deployed separately through Vercel.\n\nThese checks do not install every external tool or prove behavior on every Android\ndevice. Before relying on a new installer, test it in native Termux aarch64 with\na disposable environment and verify network, storage, PRoot, and Termux:API behavior\nfor your device.\n\n---\n\n## Support the Project\n\nIf Karnel Termux has been useful to you, consider supporting via Pix or starring on GitHub — it helps other developers discover the project.\n\n**Pix:** `037f07bd-a326-42b6-a5a3-f29b36e703db`\n\n---\n\n## License\n\nMIT © Israel Marques\n\n---\n\n\n \n ![\"Documentation\"](\"https://img.shields.io/badge/Full%20Documentation-0078D4?style=for-the-badge\")
\n \n
\n","readmeFilename":"README.md"}