Skip to main content

Crate cornichon

Crate cornichon 

Source
Expand description

cornichon — composable TUI menu patterns themed after Claude Code, Codex, and Grok.

cornichon is a Rust library that ports the menu patterns used by the major AI coding CLIs to ratatui. The five widget types (SlashMenu, SelectMenu, PermissionPrompt, ProjectPicker, ShortcutsModal) ship as builders and render via the standard frame.render_widget_ref(&menu, area) call — no ratatui knowledge required at the consumer site beyond passing the area.

The visual designs are taken from the brainless shadcn registry (Claude / Codex / Grok UIs). Three themes ship with the crate as CLAUDE, CODEX, and GROK; custom themes are struct literals.

§Quickstart

use cornichon::prelude::*;
use cornichon::ports::{KeyCode, KeyEvent, KeyModifiers};

let mut menu = SlashMenu::with_defaults()?;
// ... drive menu.update(KeyEvent) in your event loop ...

§Architecture

Internal layout follows the project’s src/{domain,ports,application,adapters} standard (see AGENTS.md for the full discussion):

§Conventions

  • update is total: every event produces a MenuAction. There is no Result return path because menus cannot be in an invalid state.
  • Builders consume self and return Self (true builder pattern).
  • The only place Result appears in the public API is at the construction boundary (build()), where parsed input is funneled through TryFrom.

Re-exports§

pub use application::PermissionPrompt;
pub use application::PermissionPromptBuilder;
pub use application::ProjectPicker;
pub use application::ProjectPickerBuilder;
pub use application::SelectMenu;
pub use application::SelectMenuBuilder;
pub use application::ShortcutsGroup;
pub use application::ShortcutsItem;
pub use application::ShortcutsModal;
pub use application::ShortcutsModalBuilder;
pub use application::SlashMenu;
pub use application::SlashMenuBuilder;
pub use application::Spinner;
pub use application::SpinnerBuilder;
pub use application::filter_indices;
pub use application::forms::Changed;
pub use application::forms::FormEvent;
pub use domain::CLAUDE;
pub use domain::CODEX;
pub use domain::Cadence;
pub use domain::Error;
pub use domain::GROK;
pub use domain::MenuAction;
pub use domain::Result;
pub use domain::Selection;
pub use domain::SpinnerStyle;
pub use domain::Theme;
pub use domain::Tick;
pub use domain::UnknownSpinnerError;
pub use domain::forms::Checkbox;
pub use domain::forms::RadioGroup;
pub use domain::forms::TextInput;
pub use domain::item::AnnotatedItem;
pub use domain::item::MenuItem;
pub use ports::MenuEvent;
pub use ports::dispatch;

Modules§

adapters
Adapters layer — infrastructure-facing implementations.
application
Application layer — state machines for each widget type.
domain
Domain layer for the cornichon menu library.
ports
Consumer-facing ports — the types consumers need to type-annotate when using cornichon.
prelude
Convenient re-exports for the most common cornichon types.