Skip to content

README.md

Latest commit

 

History

History
76 lines (57 loc) · 2.25 KB

README.md

File metadata and controls

76 lines (57 loc) · 2.25 KB
Raw

Lane

Lane is a Rust/Ratatui terminal UI for a personal GitLab-backed kanban board. GitLab is the source of truth for issues, labels, notes, and board state; Lane only stores local configuration and secrets.

Configuration

Environment variables are optional. Press Ctrl+, inside the app to open Settings (GitLab URL/project/token, AI provider, appearance, confirmations); values persist as settings.json in the OS config directory ($XDG_CONFIG_HOME/lane-ratatui or ~/.config/lane-ratatui). Environment variables (LANE_GITLAB_URL, LANE_GITLAB_TOKEN, LANE_PERSONAL_PROJECT_ID, LANE_LLM_*) still work and take precedence over saved settings.

OAuth is supported through environment/config secrets:

LANE_GITLAB_URL=https://gitlab.example.com
LANE_PERSONAL_PROJECT_ID=42
LANE_OAUTH_CLIENT_ID=...
LANE_OAUTH_REDIRECT_URI=http://127.0.0.1:8910/oauth/callback
LANE_OAUTH_SCOPE=api

LANE_OAUTH_CLIENT_SECRET is optional for public/PKCE clients. OAuth access and refresh tokens are stored under the Lane config directory with owner-only file permissions on Unix.

TLS certificate verification defaults to the platform trust store. For internal GitLab instances behind a corporate CA, install the corporate root certificate in the OS trust store and run Lane normally. Set LANE_TLS_ROOTS=webpki to force the old bundled Mozilla roots behavior. As a last-resort diagnostic only, LANE_TLS_DISABLE_VERIFICATION=true disables certificate verification and should not be used with real tokens.

Press ? inside the app for the full keyboard reference (/ search, n new issue, g generate stories, s sync, hjkl/arrows to navigate).

crates.io Package

Lane is published on crates.io as ossrandom-lane. Installing it with Cargo provides the lane command:

cargo install ossrandom-lane
lane

npm Package

@ossrandom/lane ships prebuilt binaries. Installing and running the package does not require Rust or Cargo on the target machine.

Supported platforms:

  • Node.js 22.14 or newer
  • Linux x64 and arm64
  • macOS x64 and arm64
  • Windows x64

Useful commands:

npm run format
npm run test
npm run build
npm run check:vendor
lane

Generate current TUI screenshots (PNG/SVG/TXT) for visual review:

cargo run --example screenshot_capture