Record - Documentation Recording System¶

Overview¶

The record command generates asciinema recordings of ujust commands for documentation. It automates the recording of command lifecycles (config, start, status, logs, stop, delete) across all services and tools.

Key Concept: This is a batch recording system for documentation generation. For recording individual commands, see the user-facing /bazzite-ai:record skill which uses ujust record.

This is a development command - run with just from the repository root, not ujust.

Quick Reference¶

Individual Services¶

Parameters¶

just record ACTION

Recording Categories¶

All Recordings¶

just record all

Records everything in order:

1. Pod services (ollama, jupyter, etc.)
2. Kubernetes (k3d, deploy)
3. VM commands
4. Tools
5. Config
6. Install
7. Test

Use when: Regenerating all documentation recordings.

Pod Services¶

just record pods

Records lifecycle for all pod-based services:

• ollama, jupyter, openwebui, comfyui
• fiftyone, jellyfin, portainer, runners

Each service records: config, start, status, logs, stop, delete

Kubernetes Commands¶

just record k8s

Records k3d cluster and deploy commands:

• Cluster creation and management
• Helm deployments (JupyterHub, KubeAI)

VM Commands¶

just record vm

Records virtual machine commands:

• VM add, start, status, ssh, stop, delete
• Image download and management

Individual Service¶

just record ollama
just record jupyter
just record comfyui
# etc.

Records the complete lifecycle for a specific service.

Output Structure¶

Recordings are saved to:

docs/recordings/
├── ollama/
│   ├── config.cast
│   ├── start.cast
│   ├── status.cast
│   ├── logs.cast
│   ├── stop.cast
│   └── delete.cast
├── jupyter/
│   └── ...
├── k3d/
│   └── ...
└── vm/
    └── ...

Documentation Generation¶

Generate Gallery Pages¶

just record generate-docs

Generates markdown pages with embedded asciinema players for the documentation site.

Check Recording Status¶

just record status

Shows which recordings exist and which are missing.

Common Workflows¶

Full Documentation Regeneration¶

# Record everything
just record all

# Generate gallery pages
just record generate-docs

# Build documentation
just docs-build

Update Specific Service¶

# Record just ollama
just record ollama

# Regenerate docs
just record generate-docs

Before Release¶

# Check what's recorded
just record status

# Record missing items
just record pods
just record k8s

# Generate and verify
just record generate-docs
just docs-serve

Error Handling¶

If a command fails during recording, the recording is discarded. This ensures only working commands appear in documentation.

Requirements¶

Both are pre-installed in Bazzite AI.

Troubleshooting¶

Recording Fails Immediately¶

Symptom: Recording starts but immediately fails

Cause: The ujust command itself is failing

Fix:

# Test the command manually first
ujust ollama start

# Fix any issues, then record
just record ollama

Missing Recordings in Status¶

Symptom: just record status shows missing files

Cause: Recordings not generated or failed

Fix:

# Record the missing category
just record pods  # or specific service

Gallery Not Updated¶

Symptom: Documentation doesn't show new recordings

Cause: Gallery pages not regenerated

Fix:

just record generate-docs
just docs-build

Cross-References¶

• User Recording: /bazzite-ai:record skill for individual command recording
• Documentation: /bazzite-ai-dev:build for building docs after recording
• Services: See individual service skills for command details