Skip to content

Feature Release: V1.1.0 - "ignore_updates"

Latest
Latest

Choose a tag to compare

View all tags
@dentm42 dentm42 released this 06 Mar 00:11
v1.1.0
bae8be2

Release: Version 1.1.0

Summary

  • Release name: v1.1.0
  • Artifact: single-script CLI (aver.py)
  • License: MIT
  • Purpose: Provide a lightweight, file-native knowledge tracking tool that uses plain-text Markdown records, notes, and a rebuildable SQLite index for fast local search. No server required.

Highlights / Key Features

  • Plain-text first: every record and note is stored as a human-readable Markdown file; text files are the authoritative source.
  • Git-native workflow: records live in the repository and integrate with commits, branches, and pull requests for verifiable history.
  • Rebuildable SQLite index: local index provides fast full-text search and structured queries but is non-authoritative and fully rebuildable from the files.
  • Structured fields + freeform narrative: combine queryable metadata fields with human narrative in the same system.
  • Offline and local-only operation: no background daemon, no required server, no telemetry.
  • Small single-file install
  • Minimal dependencies: PyYAML and tomli_w

What’s Included

  • CLI script (aver.py): initial single-file implementation for core record/note operations (create, append note, search, rebuild index, help, version).
  • README with philosophy, design invariants, examples, and usage guidance.
  • MANUAL.md
  • LICENSE (MIT).

Supported Use Cases

  • Software issue and decision tracking alongside code
  • Research / lab logs and experiment notes
  • Field reports and engineering deviations in low-connectivity environments
  • Editorial workflows that require traceable revision history
  • Long-term knowledge tracking where data longevity and portability matter

Installation (recommended patterns — include these short snippets in the release notes)

For issue tracking, drop the script in the root of your repo (./aver.py) or in ./utils/aver.py (Repo contains a repo.skel in the helpers directory for better integration)

Single-file download (release asset):

curl -L -o aver.py https://github.com/dentm42/aver/releases/latest/download/aver.py
python -m pip install PyYAML tomli-w
chmod a+x ./aver.py
aver.py --help

Initialize aver database:
python aver.py admin init

Get the Issue Tracking config.toml template:

cd .aver
curl -L -o config.toml https://github.com/dentm42/aver/releases/latest/download/issue_config.toml

Create your first record from anywhere inside your git repo:
aver.py record new

CONGRATS! You now have an issue tracker with all your issues reside in your git repo

**Make sure to add .aver/aver.db to your .gitignore to keep your repo from including your database.

Website and Manual: https://avercli.dev/

EXAMPLE USAGE

aver demo
Data Sovereignty in Knowledge Management.

Notes on Usage and Expectations

The SQLite index is a performance layer only. If removed or corrupted, run the rebuild command (aver.py admin reindex) to regenerate the index from plain-text files.
The tool preserves history but performs no semantic validation of content. Field names are conventions and carry meaning only within a repository’s agreed conventions.
Maintenance stance: the project is provided as a durable, minimal tool. Issues and pull requests are welcome; responses will be handled as time permits.

Repository Layout (referenced)

.aver/
records/ # One Markdown file per record
notes/ # Time-stamped notes associated with records
aver.db # Rebuildable SQLite search index
config.toml # Optional configuration

Configuration & Data Format

  • Records: Markdown files with structured metadata fields (examples and recommended conventions in README).
  • Notes: Separate, time-stamped files that preserve historical context for each record.
  • Fields: simple key = value pairs (string, numeric, boolean) used for filtering and sorting. Example syntaxes are documented in README.

Security & Privacy

  • No network telemetry, no external services required. All operations are local and explicit.
  • Users are responsible for repository backups and Git hosting choices for synchronization.

Changelog

Added Features:

  • ignore_updates - parameter for record special fields
  • metadata_only - parameter now available for JSON injected records

v1.0.0

Added Features: (non-exhaustive list)

  • Masked data fields
  • Advanced query operations
  • Optimized index rebuild
  • Advanced data "templating" and frontmatter validation
  • JSON and CLI command parity
  • Context dependent user identity
  • Search result pagination

v0.8.1 — INITIAL PUBLIC RELEASE

Initial public distribution of the single-script aver CLI
Core features: create/update records, append notes, local SQLite indexing, search & filtering
Documentation: README with philosophy, invariants, usage examples, and sample repo layout
Sample dataset included for testing and demonstration
Known Limitations / Roadmap Items

No web UI included — designed intentionally as a file-first CLI tool.
No automatic synchronization or cloud features.

Assets 7
Loading