Documentation

📄 The .CryptArt File Format

The .CryptArt file format is the universal project file for all CryptArtist Studio programs. It is a JSON file with the extension .CryptArt and the registered type name "CryptArtist Art".

The format was designed with one overriding goal: it must never need a base format upgrade. The envelope schema is stable forever. Any .CryptArt file ever created will always be readable by any version of CryptArtist Studio.

Required Fields

Only three fields are required in every .CryptArt file:

Minimal Example

{
  "$cryptart": 1,
  "program": "media-mogul",
  "data": {}
}

Recommended Fields

Compatibility Contract

Known Program IDs

Any string is valid as a program ID. Third-party programs can use their own IDs without any changes to the format.

Full Example

{
  "$cryptart": 1,
  "program": "vibecode-worker",
  "name": "My Web App",
  "createdAt": "2026-03-13T17:00:00.000Z",
  "updatedAt": "2026-03-13T18:30:00.000Z",
  "appVersion": "0.1.0",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "meta": {
    "author": "Matt",
    "email": "Matt@MattyJacks.com",
    "website": "https://mattyjacks.com",
    "tags": ["typescript", "react"],
    "license": "MIT"
  },
  "data": {
    "rootPath": "/home/matt/projects/webapp",
    "openFiles": [
      { "path": "src/App.tsx", "name": "App.tsx" }
    ],
    "activeFile": "src/App.tsx",
    "aiProvider": "openai",
    "model": "gpt-4o"
  }
}

💻 CLI Reference

Every feature in CryptArtist Studio is accessible from the command line. The CLI uses a cryptartist <command> [options] pattern.

Global Commands

# Show version
$ cryptartist --version

# Show help
$ cryptartist --help

# Launch specific program
$ cryptartist launch media-mogul
$ cryptartist launch vibecode-worker
$ cryptartist launch demo-recorder
$ cryptartist launch valley-net
$ cryptartist launch game-studio

Project Commands

# Create a new project
$ cryptartist new --program media-mogul --name "My Video"

# Open an existing project
$ cryptartist open project.CryptArt

# Show project info
$ cryptartist info project.CryptArt

# Export project to different format
$ cryptartist export --format mp4 --output video.mp4

Media Commands

# Import media from Pexels
$ cryptartist media import --source pexels --query "ocean waves"

# Import local file
$ cryptartist media import --source local --path video.mp4

# List media in project
$ cryptartist media list

# Probe media file info
$ cryptartist media probe video.mp4

AI Commands

# Generate a video from prompt
$ cryptartist ai generate --prompt "Travel vlog about Tokyo"

# Chat with AI
$ cryptartist ai chat --message "How do I add transitions?"

# Generate an image
$ cryptartist ai image --prompt "Sunset over mountains"

Server Commands

# Start the REST API server
$ cryptartist serve --port 3000

# Start with API key auth
$ cryptartist serve --port 3000 --api-key "your-key"

🌐 REST API Reference

Start the API server with cryptartist serve --port 3000. All endpoints accept and return JSON.

Authentication

If the server is started with --api-key, all requests must include the key in the Authorization header:

GET /api/status HTTP/1.1
Host: localhost:3000
Authorization: Bearer your-api-key-here
Content-Type: application/json

⚙️ Configuration

API Keys

CryptArtist Studio supports multiple AI providers. Enter your keys in the Settings modal (accessible from any program) or pass them via the CLI.

FFmpeg Setup

FFmpeg and FFprobe are automatically downloaded on first run. The installer detects your OS (Windows, macOS, Linux), downloads the appropriate binaries, verifies SHA-256 checksums, and stores them in the local AppData directory. No manual installation required.

Godot Integration

GameStudio automatically detects an installed Godot Engine or offers to download it. Configure the Godot executable path in Settings if auto-detection doesn't work.

📝 Logging System

CryptArtist Studio includes a comprehensive logging system with three rolling log files:

Log levels: DEBUG, INFO, WARN, ERROR, ACTION. The frontend logger sends structured messages to the Rust backend for unified logging across the entire stack.

⌨️ Keyboard Shortcuts

❓ Frequently Asked Questions