Skip to main content

​
Overview

The dex update command opens an interactive TUI (Text User Interface) wizard to edit an existing entry. It allows you to modify entry metadata, recording index references, and regenerate the HTML output.

​
Usage

dex update

​
Requirements

This command requires a TTY (interactive terminal). It cannot be run in non-interactive environments.

​
Features

  • Rehydrate existing entry data into editable form
  • Edit all entry fields interactively
  • Import recording index from source URL
  • Preview changes before saving
  • Regenerate entries/<slug>/index.html with updated data

​
Workflow Stages

​
1. Entry Selection

The wizard starts by displaying a list of existing entries to choose from.

​
2. Checklist Stage

  • Review which sections need updating
  • Toggle sections with Space
  • Press Enter to continue to edit stage
  • Press Esc to go back

​
3. Edit Stage

Modify entry fields:
  • Type or paste to edit current field
  • Use Up/Down arrows to switch between fields
  • Press Ctrl+I to import recording index from source URL
  • Press Enter to continue to review stage
  • Press Esc to return to checklist

​
4. Review Stage

  • Review all changes before committing
  • Press Ctrl+S to save and regenerate HTML
  • Press Esc to go back and make more edits

​
Keybindings

​
Global

  • Enter - Next step or confirm
  • Esc - Previous step or cancel
  • Ctrl+Q - Quit Dex

​
Checklist Stage

  • Space - Toggle section selection
  • Up/Down - Navigate sections

​
Edit Stage

  • Up/Down - Switch between fields
  • Ctrl+I - Import recording index from source URL
  • Enter - Continue to review

​
Review Stage

  • Ctrl+S - Save and regenerate HTML
  • Esc - Go back to edit

​
Recording Index Import

The update wizard supports importing recording index metadata from a source URL:
  1. Navigate to the recording index field
  2. Press Ctrl+I to enter import mode
  3. Paste the source URL
  4. The wizard will fetch and parse the recording index data
  5. Extracted references are automatically populated

​
What Gets Updated

When you save changes, the following files are updated:
  • entries/<slug>/entry.json - Updated entry metadata
  • entries/<slug>/index.html - Regenerated HTML page
  • entries/<slug>/description.txt - Updated description (if changed)
  • entries/<slug>/manifest.json - Updated manifest (if changed)

​
Example Session

$ dex update

[Entry list appears]
> Select entry: tim-feeney

[Checklist stage]
☑ Video URL
☐ Description
☑ Recording Index
☐ Credits

Press Enter to continue...

[Edit stage]
Title: Tim Feeney - Solo Percussion
Lookup: LOOKUP-0042
Video URL: https://vimeo.com/...
Recording Index PDF: [Ctrl+I to import]
...

[Review stage]
Review changes:
- Title: Tim Feeney - Solo Percussion
- Updated recording index references
- Modified 3 fields

Press Ctrl+S to save and regenerate

✓ Saved entry.json
✓ Regenerated index.html

dex init

Create a new entry

dex doctor

Scan entries for issues

dex entry audit

Audit entry integrity

dex view

Preview entries locally

​
Notes

  • The update wizard preserves the existing entry structure
  • HTML is automatically regenerated to match the canonical template
  • Recording index import supports automatic parsing of structured data
  • All changes are validated before saving
  • The command updates lifecycle timestamps automatically

Build docs developers (and LLMs) love

Get started for freeTalk to us