Skip to main content

CLI for the Alfred document management system

Project description

alfred

A minimal, self-consistent document management system built on PDCA + Johnny Decimal.

Quick Start

git clone git@github.com:frankyxhl/alfred.git
cd alfred

Structure

.alfred/          ← COR (Core) meta-layer documents (universal, apply to all projects)
docs/             ← ALF (Alfred) business-layer documents (project-specific)

For LLMs: How This System Works

1. Read these files first

  • .alfred/COR-0001-REF-Glossary.md — all terms and abbreviations
  • .alfred/COR-0000-REF-Document-Index.md — index of all meta-layer documents
  • docs/ALF-0000-REF-Document-Index.md — index of all business-layer documents

2. File naming format

<PREFIX>-<ACID>-<TYP>-<Title>.md
  • PREFIX: COR (universal) or 3-letter project code (ALF, BLA, CLR)
  • ACID: 4-digit Johnny Decimal number (Area + Category + Item)
  • TYP: 3-letter type code (SOP, ADR, CHG, INC, PLN, PRP, REF)

3. PDCA areas (meta layer)

Area Phase What it covers
10xx Do Create and read documents
11xx Plan Decision records and change requests
12xx Check Session retrospective
13xx Act Update, deprecate, maintain index
14xx Constraint Universal rules (atomicity, language policy)
15xx Development TDD, GitHub issues, git branch naming

4. Key rules

  • COR-1400: Every SOP does exactly one thing (atomic)
  • COR-1401: All documents in English
  • COR-1402: Always declare which SOP is being followed before starting a task

5. To create a new document

Follow COR-1001 (Create Document) for naming and numbering, then the type-specific SOP:

Type Template SOP
SOP COR-1000
ADR COR-1100
CHG COR-1101

After creation, update the index per COR-1302.

Installing into another project

Copy .alfred/ into the target project:

cp -r .alfred/ /path/to/other-project/.alfred/

The target project keeps its own docs/ for business-layer documents.

Version control

This project uses jj (Jujutsu) colocated with git.

jj log              # view history
jj status           # current changes
jj git push         # push to GitHub

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fx_alfred-0.3.0.tar.gz (32.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fx_alfred-0.3.0-py3-none-any.whl (45.9 kB view details)

Uploaded Python 3

File details

Details for the file fx_alfred-0.3.0.tar.gz.

File metadata

  • Download URL: fx_alfred-0.3.0.tar.gz
  • Upload date:
  • Size: 32.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for fx_alfred-0.3.0.tar.gz
Algorithm Hash digest
SHA256 99d6641e82a45d75c5eeb06240c1dfd034f182cfbad9c543d49c1cfd0c7e3f32
MD5 9c7c1c9aef0715650d797a31e83aec81
BLAKE2b-256 e6847fadf3d4d8097bc1115b63d17490609dc9a163a2b1df0e55024d15022d61

See more details on using hashes here.

Provenance

The following attestation bundles were made for fx_alfred-0.3.0.tar.gz:

Publisher: publish.yml on frankyxhl/alfred

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fx_alfred-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: fx_alfred-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 45.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for fx_alfred-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bc0b3951fcfe34a1a8fcffbb1633fb53660b789dd41d9e99d0f2fe79a4a38109
MD5 c87183b690acd543c0d446964a893ac2
BLAKE2b-256 4690dec0c7de88d324b38e0853e0a29e12e7cbc94afcf53de5e471bdc0c8d1c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for fx_alfred-0.3.0-py3-none-any.whl:

Publisher: publish.yml on frankyxhl/alfred

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page