Skip to content

kcosr/assistant-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Assistant CLI

TUI client for the Assistant workspace, built with FrankenTUI.

Features

  • Lists Browser: Browse and manage lists with items
    • Real-time search (scoped to selected list or global)
    • AQL query support with column selection
    • Click column headers to sort
    • WebSocket updates for real-time sync
    • Vim keybindings (j/k navigation)
    • Mouse support (click, scroll, double-click)
    • OSC 52 clipboard (works over SSH)

Installation

# Clone FrankenTUI (required dependency)
git clone https://github.com/Dicklesworthstone/frankentui.git

# Clone assistant-cli next to it
git clone https://github.com/kcosr/assistant-cli.git

# Build
cd assistant-cli
cargo build --release

# Binary is at target/release/assistant-cli
# Optionally copy it somewhere on your PATH:
cp target/release/assistant-cli ~/.local/bin/

Usage

# Set the Assistant API URL
export ASSISTANT_URL=http://localhost:3000

# Optional: Filter lists by name (comma-separated substrings)
export LISTS_FILTER=work,personal

# Run the lists browser
assistant-cli

Keybindings

Global

Key Action
q Quit
Tab Switch focus (sidebar ↔ table)
Esc Clear filter/selection, go back

Sidebar (Lists)

Key Action
/ Filter lists by name
j/k or / Navigate lists
Enter Open selected list

Table (Items)

Key Action
/ Search items
: Enter AQL query mode
n Add new item
d Delete selected item
Space Toggle completed status
t Move item to top
b Move item to bottom
o Open URL in browser
y Copy URL/title to clipboard
Enter View item details
j/k or / Navigate items

Input Modes

Key Action
Enter Confirm/execute
Esc Cancel and clear
Ctrl+C Clear input (if any) or exit mode
/ Navigate while filtering

AQL Queries

Use : to enter AQL mode. Examples:

status != completed order by updated desc
show title, tags, notes
tags contains work

Click column headers to sort (updates AQL automatically).

Environment Variables

Variable Description
ASSISTANT_URL Base URL for Assistant API (required)
LISTS_FILTER Comma-separated list name filters

Requirements

  • Rust nightly (uses 2024 edition features)
  • Terminal with mouse support
  • Assistant server running

License

MIT

About

Interactive TUI for interacting with the assistant backend

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors