Catalog Commands

The teactl catalog commands let you browse, search, and install blueprints from the Teabar catalog. The catalog includes official Teabar blueprints, community contributions, and your organization’s private blueprints.

teactl catalog search

Search for blueprints in the catalog.

teactl catalog search <query> [flags]

Flags

Flag	Description
`--tag <tag>`	Filter by tag (can specify multiple)
`--source <source>`	Filter by source: official, community, org
`--sort <field>`	Sort by: relevance, downloads, rating, updated
`--limit <n>`	Maximum results (default: 20)
`--output <format>`	Output format (table, json, yaml)

Examples

# Text search
teactl catalog search gitlab

# Search with tags
teactl catalog search kubernetes --tag education --tag cicd

# Official blueprints only
teactl catalog search --source official

# Sort by popularity
teactl catalog search cicd --sort downloads

Sample output:

$ teactl catalog search gitlab
NAME                      SOURCE    VERSION  DESCRIPTION                           RATING
teabar/gitlab-cicd        official  1.2.0    Complete GitLab CI/CD training env    4.8
teabar/gitlab-basic       official  1.0.0    Basic GitLab instance                 4.5
community/gitlab-runners  community 0.9.0    GitLab with distributed runners       4.2
community/gitlab-ha       community 0.8.0    High-availability GitLab setup        4.0

Found 4 results. Use 'teactl catalog browse' for interactive browsing.

teactl catalog browse

Launch the interactive TUI catalog browser.

teactl catalog browse [flags]

Flags

Flag	Description
`--tag <tag>`	Pre-filter by tag
`--source <source>`	Pre-filter by source

Examples

# Open catalog browser
teactl catalog browse

# Pre-filtered
teactl catalog browse --tag cicd

The browser provides a split-pane interface:

┌─[ Catalog Browser ]─────────────────────────────────────────────────────────┐
│ Search: gitlab______  Tags: [cicd] [education]  Source: [All ▼]              │
├────────────────────────────┬────────────────────────────────────────────────┤
│ BLUEPRINTS                 │ teabar/gitlab-cicd v1.2.0                      │
│ ▶ teabar/gitlab-cicd       │ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ │
│   teabar/gitlab-basic      │ Complete CI/CD training environment with      │
│   teabar/k8s-basics        │ GitLab, runners, and participant workspaces.  │
│   community/gitlab-runners │                                                │
│                            │ Variables:                                     │
│                            │   participant_count: int (1-50) = 10          │
│                            │   gitlab_version: string = "16.8"             │
│                            │   registry_enabled: boolean = true            │
│                            │                                                │
│                            │ Tags: cicd, gitlab, education                 │
│                            │ Downloads: 1,234  ★ 4.8 (56 reviews)          │
│                            │                                                │
│                            │ [Enter] Create env  [i] Install  [v] View     │
├────────────────────────────┴────────────────────────────────────────────────┤
│ ↑↓:navigate Tab:switch-pane Enter:use i:install v:view-yaml /: search q:quit│
└─────────────────────────────────────────────────────────────────────────────┘

Browser Keyboard Shortcuts

Key	Action
`↑/k`, `↓/j`	Navigate list
`/`	Focus search input
`Tab`	Switch between list and preview
`Enter`	Create environment from blueprint
`i`	Install blueprint to project
`v`	View full blueprint YAML
`t`	Toggle tag filter
`q`	Quit browser

teactl catalog get

Show detailed information about a blueprint.

teactl catalog get <name> [flags]

Flags

Flag	Description
`--version <version>`	Specific version (default: latest)
`--output <format>`	Output format (table, json, yaml)
`--yaml`	Show full blueprint YAML

Examples

# Get blueprint details
teactl catalog get teabar/gitlab-cicd

# Specific version
teactl catalog get teabar/gitlab-cicd --version 1.1.0

# Show full YAML
teactl catalog get teabar/gitlab-cicd --yaml

Sample output:

$ teactl catalog get teabar/gitlab-cicd
Name:        teabar/gitlab-cicd
Version:     1.2.0
Source:      Official
Description: Complete CI/CD training environment with GitLab, runners, and workspaces

Variables:
  NAME               TYPE      DEFAULT    DESCRIPTION
  participant_count  integer   10         Number of participant workspaces
  gitlab_version     string    "16.8"     GitLab CE version
  registry_enabled   boolean   true       Enable container registry
  runner_count       integer   2          Number of GitLab runners

Resources:
  - 1 Kubernetes cluster (Talos, 3 nodes)
  - 1 GitLab instance
  - 2 GitLab runners
  - 10 Participant namespaces (based on participant_count)

Estimated Cost: ~$2.50/hour

Tags: cicd, gitlab, education
Downloads: 1,234
Rating: ★★★★★ 4.8 (56 reviews)

Versions:
  VERSION  RELEASED      NOTES
  1.2.0    2024-01-15    Added container registry support
  1.1.0    2023-12-01    Improved runner configuration
  1.0.0    2023-10-15    Initial release

teactl catalog install

Install a blueprint to your project for customization.

teactl catalog install <name> [flags]

Flags

Flag	Description
`--version <version>`	Specific version (default: latest)
`--project <project>`	Target project (default: current)
`--name <name>`	Custom name for installed blueprint

Examples

# Install to current project
teactl catalog install teabar/gitlab-cicd

# Install with custom name
teactl catalog install teabar/gitlab-cicd --name my-cicd-workshop

# Install to specific project
teactl catalog install teabar/gitlab-cicd --project training

$ teactl catalog install teabar/gitlab-cicd
Installing teabar/gitlab-cicd v1.2.0 to project 'default'...

✓ Blueprint installed successfully

The blueprint is now available in your project:
  teactl blueprint list

To create an environment:
  teactl env create --blueprint my-cicd-workshop

To customize the blueprint:
  teactl blueprint edit my-cicd-workshop

Note

Installing a blueprint creates a copy in your project that you can customize. The original catalog blueprint is not modified.

Blueprint Sources

Official Blueprints

Maintained by the Teabar team with the teabar/ prefix:

teactl catalog search --source official

Blueprint	Description
`teabar/gitlab-cicd`	Complete GitLab CI/CD training
`teabar/k8s-basics`	Kubernetes fundamentals
`teabar/argocd-gitops`	GitOps with ArgoCD
`teabar/prometheus-stack`	Monitoring and observability
`teabar/full-devops`	Complete DevOps stack

Community Blueprints

Contributed by the community with the community/ prefix:

teactl catalog search --source community

Organization Blueprints

Private blueprints in your organization:

teactl catalog search --source org

Publishing Blueprints

Publish to Organization

Make a blueprint available within your organization:

teactl blueprint push my-blueprint.yaml --org

Publish to Community (Pro Feature)

Share your blueprint with the community:

# Validate before publishing
teactl blueprint validate my-blueprint.yaml --strict

# Publish to community catalog
teactl blueprint push my-blueprint.yaml --public

Warning

Community blueprints undergo automated validation. Ensure your blueprint follows the best practices before publishing.

Common Workflows

Quick Environment from Catalog

# Search and create in one flow
teactl catalog browse
# Select blueprint, press Enter
# Configure variables
# Create environment

Install and Customize

# Install blueprint
teactl catalog install teabar/gitlab-cicd --name my-workshop

# Edit to customize
teactl blueprint edit my-workshop

# Validate changes
teactl blueprint validate my-workshop

# Use customized blueprint
teactl env create --blueprint my-workshop --name march-training

Compare Versions

# List versions
teactl catalog get teabar/gitlab-cicd

# Compare specific versions
teactl blueprint diff teabar/gitlab-cicd:1.1.0 teabar/gitlab-cicd:1.2.0

Related Commands

blueprint - Blueprint management
env create - Create environments
TUI Catalog View - Interactive catalog browser