npm package: @nodeops-createos/cli
Description: Deploy anything to CreateOS - AI agents, APIs, MCP servers, bots, and more
Author: NodeOps
Latest version: 0.1.0-beta.9

# @nodeops-createos/cli

> Deploy anything to production with CreateOS - AI agents, APIs, MCP servers, bots, and more.

[![npm version](https://badge.fury.io/js/@nodeops-createos/cli.svg)](https://www.npmjs.com/package/@nodeops-createos/cli)
[![Beta](https://img.shields.io/badge/status-beta-orange.svg)](https://github.com/nodeops/createos-cli/issues)

---

**This is a beta release.** We welcome feedback and bug reports at [GitHub Issues](https://github.com/nodeops/createos-cli/issues).

---

## Installation

```bash
# Install globally
npm install -g @nodeops-createos/cli

# Or use directly with npx (no install needed)
npx @nodeops-createos/cli init
```

## Quick Start

```bash
# 1. Get your API key from https://createos.nodeops.network/settings/api-keys

# 2. Authenticate
createos login --token YOUR_API_KEY
# Or set environment variable:
export CREATEOS_API_KEY="your-api-key"

# 3. Initialize a project
createos init

# 4. Deploy!
createos deploy
```

## Commands

### Initialize Project

```bash
createos init                        # Interactive setup
createos init -t agent -n my-agent   # Create AI agent project
createos init -t mcp -n my-mcp       # Create MCP server
createos init -t api -n my-api       # Create API service
```

### Deploy

```bash
createos deploy                  # Deploy current directory
createos deploy -d ./dist        # Deploy specific directory
createos deploy -b main          # Deploy specific branch (VCS)
createos deploy -i nginx:latest  # Deploy Docker image
```

### Quick Deploy Shortcuts

```bash
createos agent my-agent -r org/repo    # Deploy AI agent from GitHub
createos mcp my-mcp -r org/repo        # Deploy MCP server
createos api my-api -r org/repo        # Deploy API service
createos bot my-bot -i mybot:latest    # Deploy bot from Docker
```

### Project Management

```bash
createos list                    # List all projects
createos logs my-project         # View runtime logs
createos logs my-project -t build # View build logs
createos env list my-project     # List environment variables
createos env set my-project prod -k API_KEY -v secret
```

### Domains

```bash
createos domains list my-project
createos domains add my-project -d api.example.com
createos domains verify my-project -d api.example.com
createos domains remove my-project -d api.example.com
```

### AI Agent Integration

```bash
createos skill              # Show skill info
createos skill install      # Install skill files for AI agents
createos skill export -o ./my-skill
```

## For AI Agents (MCP)

If you're using OpenClaw, Claude, MoltBot, or other AI agents with MCP:

**MCP Endpoint:** `https://api-createos.nodeops.network/mcp`

No API key needed when connected via MCP! Just call tools directly:

```
CreateProject(...)
UploadDeploymentFiles(...)
ListProjects(...)
```

## Configuration

### Environment Variables

- `CREATEOS_API_KEY` - Your API key (required)
- `CREATEOS_API_URL` - Custom API URL (optional)

### Project Config (createos.json)

Created automatically by `createos init`:

```json
{
  "uniqueName": "my-app",
  "displayName": "My App",
  "type": "upload",
  "source": {},
  "settings": {
    "runtime": "node:20",
    "port": 3000
  }
}
```

## Supported Technologies

**Runtimes:** node:18, node:20, node:22, python:3.11, python:3.12, golang:1.22, rust:1.75, bun:1.3, static

**Frameworks:** nextjs, reactjs-spa, vuejs-spa, nuxtjs, astro, express, fastapi, flask, django, gin

## Programmatic Usage

```javascript
import { CreateOSClient } from 'createos';

const client = new CreateOSClient('your-api-key');

// Create project
const project = await client.createProject({
  uniqueName: 'my-app',
  displayName: 'My App',
  type: 'upload',
  source: {},
  settings: { runtime: 'node:20', port: 3000 }
});

// Deploy files
await client.uploadFiles(project.id, [
  { path: 'index.js', content: 'console.log("Hello!")' }
]);
```

## Beta Program

This CLI is currently in **open beta**. We appreciate your feedback!

- **Report bugs:** [GitHub Issues](https://github.com/nodeops/createos-cli/issues)
- **Request features:** [Feature Requests](https://github.com/nodeops/createos-cli/issues/new?template=feature_request.md)
- **Beta documentation:** [docs/BETA.md](./docs/BETA.md)

### Updating

Always use the latest beta version for the best experience:

```bash
npm update -g @nodeops-createos/cli
```

## Links

- **Homepage:** https://createos.io
- **Dashboard:** https://createos.nodeops.network
- **API Docs:** https://api-createos.nodeops.network/api-docs
- **Documentation:** https://createos.io/docs

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to contribute.

## License

MIT - see [LICENSE](./LICENSE) for details.