lazylens 0.3.0

A fast TUI lens over work knowledge

lazylens

A fast terminal lens over work knowledge.

lazylens builds a local SQLite/FTS index over work knowledge, then gives you a keyboard-first Textual TUI for search, source structure, previews, and cross-linked document relationships.

The intended first use case is an Atlassian project: Confluence pages provide the design/document structure, Jira issues provide delivery detail, and relationships let you navigate between them without losing the source context. Local folders are also supported for notes, demos, and non-cloud documents. SharePoint is planned next.

Screenshot

Features

• Local SQLite index with FTS5 search.
• Confluence Cloud indexing with page hierarchy, folders, snippets, and links.
• Jira Cloud indexing with issues, hierarchy, snippets, and linked issues.
• Cross-source relationship navigation: Confluence pages can lead into Jira Epics/Stories/Bugs and Jira issues can lead back to Confluence LLDs/KDDs.
• Local folder indexing for Markdown, text, and other readable project files.
• TUI structure navigation: source, top-level pages, folders, and child pages.
• Browser/file opening from the selected page.
• Optional Nerd Font icon mode for richer terminal presentation.

Install

From PyPI:

pipx install lazylens
lazylens --help

From a checkout:

git clone https://github.com/richlee/lazylens.git
cd lazylens
python3 -m venv .venv
.venv/bin/python -m pip install -e ".[dev]"
.venv/bin/lazylens --help

On Windows PowerShell:

git clone https://github.com/richlee/lazylens.git
cd lazylens
py -m venv .venv
.\.venv\Scripts\python -m pip install -e ".[dev]"
.\.venv\Scripts\lazylens --help

Quick Start

For a real Atlassian project, configure Confluence and Jira as separate sources that share the same Atlassian env file:

lazylens init confluence \
  --base-url "https://example.atlassian.net" \
  --email "[e-mail]" \
  --space-key ARCH

lazylens init jira \
  --base-url "https://example.atlassian.net" \
  --email "[e-mail]" \
  --project-key ARCH

Edit the generated env file and paste your Atlassian API token:

${EDITOR:-vi} ~/.config/lazylens/atlassian.env
source ~/.config/lazylens/atlassian.env
lazylens doctor
lazylens index
lazylens

Inside the TUI, sources remain separate in the top row. The structure pane stays source-specific, while the outgoing/incoming relationship panes can cross between Confluence and Jira.

For a no-credentials demo:

lazylens demo
lazylens

Useful commands:

lazylens doctor
lazylens index
lazylens search architecture
lazylens

Atlassian Setup

lazylens uses Atlassian API-token basic auth for Confluence Cloud and Jira Cloud. Remote APIs are used only to refresh the local SQLite index; TUI search and navigation read from local data.

Credentials belong in:

~/.config/lazylens/atlassian.env

Source scope belongs in:

~/.config/lazylens/config.toml

Token values should stay out of config.toml and out of source control.

For personal or non-client testing, create a small Atlassian Cloud site, add a Confluence space and Jira project, create an API token from your Atlassian account security settings, then run lazylens doctor before indexing.

Confluence Source

Generate or append a Confluence source:

lazylens init confluence \
  --base-url "https://example.atlassian.net" \
  --email "[e-mail]" \
  --space-key ARCH

Then:

source ~/.config/lazylens/atlassian.env
lazylens index personal-confluence

Jira Source

Generate or append a Jira source:

lazylens init jira \
  --base-url "https://example.atlassian.net" \
  --email "[e-mail]" \
  --project-key LAZY

Then:

source ~/.config/lazylens/atlassian.env
lazylens index personal-jira

By default, Jira config uses project_keys to build a JQL query. You can use a custom jql value in config.toml when you need a narrower scope.

Jira snippets and embedded links come from the first configured description field that contains content. This supports projects that use custom fields such as Description (DSP) instead of the standard Jira description field.

Local Folder Source

Local folders are useful for notes, exported documents, or demos:

lazylens init --root ~/Documents/notes --name Notes --key notes
lazylens index notes

Configuration

Default config path:

• macOS/Linux: ~/.config/lazylens/config.toml
• Windows: %APPDATA%\lazylens\config.toml

Default database path:

• macOS/Linux: ~/.local/share/lazylens/index.sqlite3
• Windows: %LOCALAPPDATA%\lazylens\index.sqlite3

Example:

database = "~/.local/share/lazylens/index.sqlite3"

[ui]
icon_style = "ascii" # ascii, unicode, or nerd

[sources."notes"]
name = "Notes"
type = "local"
root = "~/Documents/notes"

[sources."personal-confluence"]
name = "Personal Confluence"
type = "confluence"
space_keys = ["ARCH"]
page_limit = 100
max_pages = 5

[sources."personal-jira"]
name = "Personal Jira"
type = "jira"
project_keys = ["LAZY"]
description_fields = ["description"]
issue_limit = 100
max_pages = 5

For Confluence, space_keys is usually the friendliest scope to configure. You can also configure space_ids if you already know them. page_limit controls API page size, and max_pages limits how many API result pages are fetched per space.

For Jira, project_keys is the simplest scope. You can set jql instead when you want to index a board, issue type, component, label, or other controlled slice. description_fields is an ordered list of Jira field IDs or names to use for snippets and embedded links. The first field with content wins, so a project using a custom field can use:

description_fields = ["description", "Description (DSP)"]

If needed, base_url, email, or api_token_env can be set on Atlassian sources. Token values should stay out of TOML. CONFLUENCE_BASE_URL may be either the Atlassian site root or the /wiki URL; JIRA_BASE_URL should be the Atlassian site root.

TUI Keys

• 1-9: switch source
• /: focus search
• c: clear search
• r: refresh configured sources
• Enter: select structure, open pages, or drill into folders
• Right / Space: drill into page/folder children or follow selected links
• Left / Backspace: go back from a drilled view
• q: quit

Icons

The TUI defaults to portable ASCII labels. For richer icons:

[ui]
icon_style = "nerd" # ascii, unicode, or nerd

nerd mode expects a Nerd Font in your terminal, for example FiraCode Nerd Font. On macOS with Homebrew:

brew install --cask font-fira-code-nerd-font

Development

python3 -m venv .venv
.venv/bin/python -m pip install -e ".[dev]"
.venv/bin/python -m pytest

The project is intentionally local-first: remote APIs refresh the index, while interactive search/navigation reads from SQLite.

See docs/plan.md for the broader direction.

References

• Confluence Cloud REST API v2 pages
• Confluence Cloud REST API v2 spaces
• Jira Cloud REST API issue search
• Atlassian basic auth for REST APIs