Skip to main content

​
Welcome to Dex CLI

Dex is a powerful command-line tool that combines an interactive Terminal User Interface (TUI) with comprehensive CLI commands for managing content operations, catalog curation, and deployment workflows.

Quick Start

Get up and running with Dex in minutes

Command Reference

Explore all available commands

TUI Dashboard

Learn about interactive mode

Workflows

Production-ready workflows

​
What is Dex?

Dex is a comprehensive operations tool designed for teams managing content entries, catalogs, and multi-environment deployments. It provides:
  • Interactive TUI Dashboard with command palette for visual workflow management
  • Entry Lifecycle Management including creation, updates, validation, and repair
  • Catalog & Content Curation tools for organizing and publishing content
  • Multi-Environment Deployment with test/prod workflows and preflight checks
  • Newsletter & Polls Management for audience engagement
  • Protected Assets & Release Orchestration with validation and publishing
  • Workspace Configuration supporting multi-repo setups

​
Key Features

TUI Mode

Interactive dashboard with keybindings for efficient navigation and command execution

Entry Management

Create, update, and validate content entries with built-in wizard and doctor tools

Catalog Operations

Manage catalog manifests, spotlight entries, and publish to multiple environments

Deployment Tools

Preflight checks, release orchestration, and automated deployment workflows

Content Tools

Notes, polls, and newsletter management with validation and publishing

Asset Management

Protected assets validation, diff checking, and multi-environment publishing

​
How It Works

Dex operates in two primary modes:

​
Interactive TUI Mode

Launch the dashboard to access all commands through an intuitive interface: 
dex
Navigate using keyboard shortcuts, use the command palette (?), and manage your content operations visually.

​
Direct CLI Mode

Execute specific commands directly from your terminal: 
dex init              # Create new entry
dex catalog validate  # Validate catalog
dex deploy            # Deploy to production

​
Architecture

Dex manages two primary repository contexts:
  • Site Repository - Content authoring, catalog/data manifests, HTML generation, and publish orchestration
  • API Repository - Worker endpoints, database operations, and admin/user APIs
The workspace configuration allows seamless switching between repositories and maintains consistent operational context.

​
Getting Started

1

Install Dependencies

Clone the repository and install dependencies:
npm install
2

Configure Workspace

Run the setup wizard to configure your workspace:
node scripts/dex.mjs setup
3

Launch Dashboard

Start the interactive dashboard:
node scripts/dex.mjs

Continue to Quickstart

Learn how to create your first entry and explore core workflows

​
Use Cases

​
Content Operations

  • Create and manage content entries with validation
  • Audit entries for drift and health issues
  • Link entries to catalog with metadata

​
Catalog Management

  • Add, edit, and retire catalog entries
  • Manage seasons and spotlight features
  • Diff and publish to test/prod environments

​
Publishing Workflows

  • Run preflight checks before releases
  • Publish assets, catalog, and home featured
  • Deploy with integrated validation

​
Editorial Tools

  • Create and edit notes with frontmatter
  • Build and publish notes bundles
  • Manage polls and newsletter campaigns

​
Next Steps

Installation

Set up Dex in your environment

Core Concepts

Understand workspaces and entries

Command Reference

Explore all available commands

Troubleshooting

Common issues and solutions

Build docs developers (and LLMs) love

Get started for freeTalk to us