onflyt-cli 1.0.1-beta.0

package/README.md

@@ -0,0 +1,338 @@
+<p align="center">
+  <svg width="128" height="128" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <path d="M12 3L18 7V13L12 17L6 13V7L12 3Z" stroke="#f59e0b" stroke-width="2" opacity="0.4"/>
+    <path d="M12 8L17 11V16L12 19L7 16V11L12 8Z" stroke="#f59e0b" stroke-width="2.5" fill="#f59e0b" fill-opacity="0.1"/>
+    <circle cx="12" cy="12" r="2" fill="#f59e0b"/>
+  </svg>
+</p>
+
+<h1 align="center">Onflyt CLI</h1>
+
+<p align="center">
+  <img src="https://img.shields.io/npm/v/onflyt?style=flat-square" alt="npm version">
+  <img src="https://img.shields.io/node/v/onflyt?style=flat-square" alt="node version">
+  <img src="https://img.shields.io/npm/dm/onflyt?style=flat-square" alt="downloads">
+  <img src="https://img.shields.io/github/license/miiglu/onflyt?style=flat-square" alt="license">
+  <img src="https://img.shields.io/badge/TypeScript-007ACC?style=flat-square&logo=typescript&logoColor=white" alt="TypeScript">
+  <img src="https://img.shields.io/badge/React-61DAFB?style=flat-square&logo=react&logoColor=black" alt="React">
+  <img src="https://img.shields.io/badge/Ink-Cli-ff69b4?style=flat-square" alt="Ink CLI">
+  <img src="https://img.shields.io/badge/Cloudflare-F38020?style=flat-square&logo=cloudflare&logoColor=white" alt="Cloudflare">
+  <img src="https://img.shields.io/badge/Beta-FFA500?style=flat-square" alt="Beta">
+  <img src="https://img.shields.io/badge/Node.js-339933?style=flat-square&logo=node.js&logoColor=white" alt="Node.js">
+</p>
+
+## What is Onflyt?
+
+Onflyt is the best platform for deploying Node.js and Python APIs. Deploy your APIs on a stateful serverless pod. Pay only per use - no subscription required.
+
+- **Serverless pods** - Secure, isolated pods that survive hibernation
+- **Pay per use** - Only pay for what you deploy, no subscriptions
+- **Global edge network** - 280+ cities for instant global deployment
+
+## Features
+
+- **Quick Deployments** - Deploy projects with a single command
+- **GitHub OAuth** - Secure authentication via GitHub
+- **Login & Manage** - Login to manage your applications from the CLI
+- **AI Agent Templates** - Deploy AI agents and LLM-powered backends
+- **Multi-Project Management** - Manage multiple projects across teams
+- **Real-time Logs** - Stream live deployment logs
+- **Rollback Support** - Revert to previous deployments instantly
+- **Team Billing** - Track credits and manage team resources
+
+## Installation
+
+### Prerequisites
+
+- Node.js 18 or higher
+- npm, yarn, pnpm, or bun
+
+### Install via npm
+
+```bash
+npm install -g onflyt
+```
+
+### Install via other package managers
+
+```bash
+# Using yarn
+yarn global add onflyt
+
+# Using pnpm
+pnpm add -g onflyt
+
+# Using bun
+bun add -g onflyt
+```
+
+## Quick Start
+
+```bash
+# 1. Authenticate with your account
+onflyt login
+
+# 2. Initialize a project in your current directory
+onflyt init
+
+# 3. Deploy your project
+onflyt deploy
+```
+
+That's it! Your project is now live on onflyt.
+
+## Authentication
+
+Onflyt uses GitHub OAuth for secure authentication.
+
+```bash
+# Login to your account
+onflyt login
+
+# Check who you're logged in as
+onflyt whoami
+
+# Logout when you're done
+onflyt logout
+```
+
+## Commands
+
+### Project Management
+
+#### `onflyt init`
+
+Initialize a new project in the current directory.
+
+```bash
+# Interactive initialization
+onflyt init
+
+# With flags for quick setup
+onflyt init --name my-app --framework nextjs --yes
+
+# Available options:
+#   --name <name>              Project name
+#   --template <id>            Template (blank, nextjs, react-vite, etc.)
+#   --framework <fw>           Framework (nextjs, react, node, etc.)
+#   --package-manager <pm>      Package manager (npm, bun, yarn, pnpm)
+#   --git                      Connect Git repository
+#   --no-git                   Skip Git connection
+#   -y, --yes                 Skip all prompts
+```
+
+#### `onflyt deploy`
+
+Deploy your project to Onflyt cloud infrastructure.
+
+```bash
+# Interactive deployment
+onflyt deploy
+
+# Deploy to specific team
+onflyt deploy --team tm_xxxxxxxxxxxx
+```
+
+#### `onflyt projects`
+
+List and manage your projects.
+
+```bash
+onflyt projects
+```
+
+#### `onflyt delete`
+
+Delete a project.
+
+```bash
+onflyt delete
+```
+
+### Deployment Management
+
+#### `onflyt logs`
+
+View deployment logs.
+
+```bash
+# View stored logs
+onflyt logs <deployment-id>
+
+# Stream live logs
+onflyt logs <deployment-id> --live
+# or
+onflyt logs <deployment-id> -l
+```
+
+#### `onflyt deployments`
+
+List deployments for a project.
+
+```bash
+onflyt deployments
+```
+
+#### `onflyt rollback`
+
+Rollback to a previous deployment.
+
+```bash
+onflyt rollback
+```
+
+### Team & Billing
+
+#### `onflyt teams`
+
+List your teams.
+
+```bash
+onflyt teams
+```
+
+#### `onflyt credits`
+
+Check credits balance for your teams.
+
+```bash
+onflyt credits
+```
+
+## Global Options
+
+| Option            | Description                      |
+| ----------------- | -------------------------------- |
+| `-h, --help`      | Show help information            |
+| `-v, --version`   | Show version number              |
+| `-t, --team <id>` | Target specific team             |
+| `--no-open`       | Don't auto-open browser on login |
+
+## Keyboard Shortcuts
+
+When using interactive commands:
+
+| Key       | Action             |
+| --------- | ------------------ |
+| `↑` / `↓` | Navigate selection |
+| `Enter`   | Select / Confirm   |
+| `Esc`     | Go back / Cancel   |
+| `Q`       | Quit               |
+| `Ctrl+C`  | Quit               |
+
+## Configuration
+
+### Project Configuration (`onflyt.json`)
+
+Created automatically by `onflyt init`:
+
+```json
+{
+  "name": "my-project",
+  "framework": "nextjs",
+  "team": "team_xxx"
+}
+```
+
+### Credentials
+
+Credentials are stored in `~/.onflyt/config.json`.
+
+## Examples
+
+### Deploy a Next.js project
+
+```bash
+onflyt init --name my-next-app --framework nextjs --yes
+cd my-next-app
+# Add your code...
+onflyt deploy
+```
+
+### Deploy with specific team
+
+```bash
+onflyt deploy --team tm_xxxxxxxxxxxx
+```
+
+### Monitor live logs
+
+```bash
+onflyt logs dep_xxxxxxxxxxxx --live
+```
+
+### Quick project initialization
+
+```bash
+onflyt init --name my-app --framework react-vite --package-manager pnpm --yes
+```
+
+## Troubleshooting
+
+### Login issues
+
+If you encounter login issues:
+
+1. Make sure GitHub is accessible
+2. Check your internet connection
+3. Try logging out and back in: `onflyt logout && onflyt login`
+
+### Deployment fails
+
+1. Check your credits balance: `onflyt credits`
+2. Verify your project configuration in `onflyt.json`
+3. View deployment logs: `onflyt logs <deployment-id>`
+
+### Command not found
+
+If `onflyt` is not found after installation:
+
+1. Make sure npm global bin is in your PATH
+2. Try reinstalling: `npm install -g onflyt`
+
+## Development
+
+### Building from source
+
+```bash
+# Clone the repository
+git clone https://github.com/miiglu/onflyt.git
+cd onflyt/services/cli
+
+# Install dependencies
+pnpm install
+
+# Build
+pnpm build
+
+# Run locally
+pnpm start
+```
+
+### Architecture
+
+The CLI is built with:
+
+- [Ink](https://github.com/vadimdemedes/ink) - React for CLIs
+- [React](https://react.dev) - UI components
+- [TypeScript](https://www.typescriptlang.org) - Type safety
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Support
+
+- [Documentation](https://docs.onflyt.com/cli)
+- [Website](https://onflyt.com)
+- [Issues](https://github.com/miiglu/onflyt-cli/issues)
+
+---
+
+<p align="center">
+  Built by <a href="https://miiglu.com">Miiglu</a>
+</p>