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 documentsdocs/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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fx_alfred-0.3.3.tar.gz.
File metadata
- Download URL: fx_alfred-0.3.3.tar.gz
- Upload date:
- Size: 33.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
43322481f4a549916e0149a66fd6bc26f8fbb51c3d154b2a73adfb93e48127f5
|
|
| MD5 |
3a2fcb24819090cc647e27d9f62146b7
|
|
| BLAKE2b-256 |
985a3eea0d179a57c5cef02148fd8aea9d92b8b9ceccc70696a0c0db46ac65ae
|
Provenance
The following attestation bundles were made for fx_alfred-0.3.3.tar.gz:
Publisher:
publish.yml on frankyxhl/alfred
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fx_alfred-0.3.3.tar.gz -
Subject digest:
43322481f4a549916e0149a66fd6bc26f8fbb51c3d154b2a73adfb93e48127f5 - Sigstore transparency entry: 1114457278
- Sigstore integration time:
-
Permalink:
frankyxhl/alfred@e93683e27280cb8558a3a65487ae0cc6d3c1c2bc -
Branch / Tag:
refs/tags/v0.3.3 - Owner: https://github.com/frankyxhl
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e93683e27280cb8558a3a65487ae0cc6d3c1c2bc -
Trigger Event:
release
-
Statement type:
File details
Details for the file fx_alfred-0.3.3-py3-none-any.whl.
File metadata
- Download URL: fx_alfred-0.3.3-py3-none-any.whl
- Upload date:
- Size: 46.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d80c1ba52b3a8714e88ffdf324b841f9ea09320371460a183805f34fd9550e06
|
|
| MD5 |
7ccd123ba3e8e955482c42d1ef1f50a6
|
|
| BLAKE2b-256 |
18d95642ec31028562eeee45ef689412bd8132efa8a638fefcaed1a722e8f6f0
|
Provenance
The following attestation bundles were made for fx_alfred-0.3.3-py3-none-any.whl:
Publisher:
publish.yml on frankyxhl/alfred
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fx_alfred-0.3.3-py3-none-any.whl -
Subject digest:
d80c1ba52b3a8714e88ffdf324b841f9ea09320371460a183805f34fd9550e06 - Sigstore transparency entry: 1114457285
- Sigstore integration time:
-
Permalink:
frankyxhl/alfred@e93683e27280cb8558a3a65487ae0cc6d3c1c2bc -
Branch / Tag:
refs/tags/v0.3.3 - Owner: https://github.com/frankyxhl
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e93683e27280cb8558a3a65487ae0cc6d3c1c2bc -
Trigger Event:
release
-
Statement type: