prompt-driven-basb
v0.1.12
Published
Prompt-driven Building a Second Brain workspace packaged for npm.
Maintainers
Readme
BASB Prompt Workspace
This workspace implements BASB as a Codex-operated prompt system, not as an external application.
What This Workspace Contains
BASBGuide.md: the architectural reference document for deeper BASB design work..basb/system/: package-owned canonical BASB state that refreshes on upgrade..basb/prompts/: reusable prompts for BASB operations, including source ingest, knowledge lint, and retrieval refresh.state/: workspace-local BASB state, review queues, and decision logs.templates/: note and brief templates with YAML frontmatter, including an immutable source-note template.vault/: the working knowledge base.vault/projects/,vault/areas/,vault/resources/,vault/archives/hold compiled notes in P.A.R.A.vault/sources/preserves immutable source material as an operational provenance layer.vault/index.mdcatalogs high-value compiled notes,vault/log.mdlogs meaningful knowledge events, andvault/retrieval/holds derived retrieval artifacts such as the catalog, question map, pattern index, and relationship index.examples/: sample inputs and expected outputs.
Core Idea
Codex is the BASB engine.
- The filesystem is the vault.
- Prompt files define behavior.
- Markdown files hold both content and metadata.
- Frontmatter keeps the files readable while staying structured.
License
MIT
Session Start
For a normal BASB session:
- Read
AGENTS.md. - Read
.basb/prompts/01-session-start.md. - Let that dispatcher classify the task and load only the minimum relevant BASB files.
Read BASBGuide.md only for BASB-system maintenance, prompt design, package-maintainer work, or architecture review.
Read .basb/prompts/00-master-system.md when the session is BASB-system maintenance or another deeper multi-file BASB change.
Use .basb/system/ for canonical package rules and state/ for workspace-local BASB memory.
Typical Workflow
- Capture or ingest. Durable source material goes through
.basb/prompts/11-ingest-source.md, which writes an immutable source note invault/sources/and updates derived compiled notes in P.A.R.A. - Create or update compiled notes in
projects,areas,resources, orarchives. Each compiled note carriesartifact_kind, provenance fields, and a stablecanonical_idfor the compiled note's retrieval identity. Provenance fields such asderived_fromandsource_idspoint back to source lineage. Richer aliases, question mappings, and patterns live invault/retrieval/. - Distill the compiled note in layers. Immutable source notes are never rewritten.
- Refresh
vault/retrieval/with.basb/prompts/62-retrieval-refresh.mdfor any materially changed bounded note set. - Express reusable outputs back into the vault by default so a one-off answer does not stay trapped in a chat.
- Run daily and weekly maintenance. Weekly maintenance runs
.basb/prompts/61-knowledge-lint.mdto surface orphans, stale summaries, contradictions, broken source lineage, and retrieval drift.
Meaningful changes are recorded in vault/log.md, high-value pages are cataloged in vault/index.md, and derived retrieval support files live under vault/retrieval/. Everything stays local-first and file-based.
Frontmatter Policy
Use YAML frontmatter on operational markdown files for:
- tags
- summary
- related docs
- source metadata
- routing rationale
- status
Keep the note body for actual content, extracted insight, and next actions.
First Real Use
- Run
.basb/prompts/10-capture.mdon the input. The dispatcher decides transient vs. direct compiled-note update vs. durable source ingest. - For durable source material, hand off to
.basb/prompts/11-ingest-source.md. The source is preserved verbatim invault/sources/and the compiled notes it affects are updated in P.A.R.A. - If a compiled note's P.A.R.A. destination is still unclear, route with
.basb/prompts/20-organize-route.md, and escalate with.basb/prompts/21-human-review.mdonly when truly ambiguous. - Distill the compiled note with the
30-32prompt chain. - Refresh
vault/retrieval/with.basb/prompts/62-retrieval-refresh.mdafter any materially changed bounded note set so retrieval artifacts stay current. - Run weekly maintenance via
.basb/prompts/60-weekly-maintenance.md; it invokes knowledge lint, retrieval refresh, and favorite-problem matching for you.
Scope Boundary
Do not turn this workspace into an application stack. The goal is prompt-driven operation through Codex using local files only.
