README
¶
lognav
lognav is a terminal UI and CLI for searching IBM Cloud Logs. It supports parallel Dataprime queries, jq filtering, snapshots, and optional API-key or 1Password authentication.
Install
With Go:
go install -trimpath github.com/bevicted/lognav@latest
lognav completion --install
Or build from source:
git clone https://github.com/bevicted/lognav.git
cd lognav
mkdir -p bin
go build -trimpath -o bin/lognav .
./bin/lognav completion --install
Configure an instance
lognav has no configured instances by default. Use ./bin/lognav config status
to find and diagnose the user.yaml file, then add an IBM Cloud Logs instance:
version: 1
icl:
instances:
- name: production
crn: "crn:v1:bluemix:public:logs:us-south:a/<account-id>:<instance-id>::"
Replace the placeholder CRN values with the instance's IBM Cloud Resource Name.
Existing config.yaml files are not loaded or changed. If user.yaml does not
exist, rename config.yaml manually. If both files exist, reconcile them
manually without overwriting either file.
config status reports homebrew, system, and user file layers as
valid, missing, or error, followed by effective configuration validation.
Use ./bin/lognav config status -o json for scripts; the editable path is the
path of the user record in files.
Run ./bin/lognav and complete the IAM browser/passcode prompt, or use
./bin/lognav login first. See the embedded setup guide and run
./bin/lognav --help or ./bin/lognav config describe to discover commands and
configuration fields. If you installed with go install, use lognav instead of
./bin/lognav.
License
lognav is licensed under the Apache License 2.0.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
archive
Package archive is the local registry for IBM Cloud Logs background queries dispatched from lognav.
|
Package archive is the local registry for IBM Cloud Logs background queries dispatched from lognav. |
|
deps
Package deps holds lognav's shared dependency bundle.
|
Package deps holds lognav's shared dependency bundle. |
|
deps/depstest
Package depstest provides a deps.Bundle builder for tests.
|
Package depstest provides a deps.Bundle builder for tests. |
|
externaleditor
Package externaleditor provides the shared external-query-editor workflow.
|
Package externaleditor provides the shared external-query-editor workflow. |
|
filter
Package filter defines the rule vocabulary for the logviewer's filter stage: the only pipeline stage that hides logs.
|
Package filter defines the rule vocabulary for the logviewer's filter stage: the only pipeline stage that hides logs. |
|
logging
Package logging sets up structured logging for lognav using log/slog.
|
Package logging sets up structured logging for lognav using log/slog. |
|
querytemplate
Package querytemplate resolves configured startup query text.
|
Package querytemplate resolves configured startup query text. |
|
secret
Package secret provides a self-redacting string type for credential values.
|
Package secret provides a self-redacting string type for credential values. |
|
snapshot
Package-level additions for CLI snapshot management.
|
Package-level additions for CLI snapshot management. |
|
snapshot/snapshottest
Package snapshottest provides test helpers for building real snapshot containers on disk.
|
Package snapshottest provides test helpers for building real snapshot containers on disk. |
|
state/statetest
Package statetest provides test-only helpers for state.Manager.
|
Package statetest provides test-only helpers for state.Manager. |
|
ui/canvas
Package canvas provides terminal-canvas cell helpers used by TUI components.
|
Package canvas provides terminal-canvas cell helpers used by TUI components. |
|
ui/components/archivehandler
Package archivehandler is the Archive tab component.
|
Package archivehandler is the Archive tab component. |
|
ui/components/buttonstrip
Package buttonstrip lays out, draws and hit-tests the single-row button strip used by the dialog and the filter-menu overlays: each label padded with one space on either side, the padded chunks placed adjacent with no separator, and the whole strip centred within an explicit horizontal span.
|
Package buttonstrip lays out, draws and hit-tests the single-row button strip used by the dialog and the filter-menu overlays: each label padded with one space on either side, the padded chunks placed adjacent with no separator, and the whole strip centred within an explicit horizontal span. |
|
ui/components/component/componenttest
Package componenttest exposes shared test helpers for components in ui/components/.
|
Package componenttest exposes shared test helpers for components in ui/components/. |
|
ui/components/component/testutil
Package testutil provides shared helpers for component tests.
|
Package testutil provides shared helpers for component tests. |
|
ui/components/contextmenu
Package contextmenu implements a modal overlay presenting a vertical, fuzzy-searchable list of actions — the traditional right-click context menu.
|
Package contextmenu implements a modal overlay presenting a vertical, fuzzy-searchable list of actions — the traditional right-click context menu. |
|
ui/components/filtermenu
Package filtermenu implements the filter-menu overlay: a vertical list of editable rule pills (each a mode chip + value input) plus an Apply/Clear/Cancel button row, navigated by the unified content/buttons scheme.
|
Package filtermenu implements the filter-menu overlay: a vertical list of editable rule pills (each a mode chip + value input) plus an Apply/Clear/Cancel button row, navigated by the unified content/buttons scheme. |
|
ui/components/helpoverlay
Package helpoverlay implements an overlay component that displays the active tab's keybinds.
|
Package helpoverlay implements an overlay component that displays the active tab's keybinds. |
|
ui/components/keyhintline
Package keyhintline draws the active view's curated keybinding hints.
|
Package keyhintline draws the active view's curated keybinding hints. |
|
ui/components/statusline
Package statusline renders view-owned contextual status pills.
|
Package statusline renders view-owned contextual status pills. |
|
ui/components/uieditor
Package uieditor is a pure-ultraviolet multi-line text editor that replaces bubbles/textarea at lognav's only multi-line site (the query editor).
|
Package uieditor is a pure-ultraviolet multi-line text editor that replaces bubbles/textarea at lognav's only multi-line site (the query editor). |
|
ui/components/uiinput
Package uiinput is a single-line, cell-native text input that replaces bubbles/textinput at lognav's single-line sites (bar, list fuzzy filter, dialog input).
|
Package uiinput is a single-line, cell-native text input that replaces bubbles/textinput at lognav's single-line sites (bar, list fuzzy filter, dialog input). |
|
ui/numeric
Package numeric provides small numeric helpers shared across UI components.
|
Package numeric provides small numeric helpers shared across UI components. |
|
ui/status
Package status provides phase enumerations for components that report their lifecycle state (auth, instance, snapshot, etc.).
|
Package status provides phase enumerations for components that report their lifecycle state (auth, instance, snapshot, etc.). |
Click to show internal directories.
Click to hide internal directories.