trugs-folder
TRUGS cartography. One binary, trug-a-folder — keep a directory tree and
its TRUG graph in sync, validate it against the folder governance rules, and
render a human-readable ARCHITECTURE.md from it. Implements TRUGS 2.0
(core_v2.0.0).
The idea: the folder is a graph. folder.trug.json holds one node per file,
typed by the governance vocabulary (code is COMPONENT, prose is DOCUMENT),
and the tool keeps that graph honest as the directory changes.
Install
pip install trugs-folder
Quickstart
trug-a-folder init myproject --scan -d "My first mapped folder"
trug-a-folder check myproject
trug-a-folder render architecture myproject
trug-a-folder sync myproject # reconcile after files change
New to TRUGS? The five-minute on-ramp: GETTING_STARTED.md
Command surface
Fourteen verbs on the trug-a-folder binary:
| verb | what it does |
|---|---|
init |
Initialize folder.trug.json in a directory |
check |
Validate against the governance rules |
sync |
Reconcile the graph with the filesystem |
render |
Render ARCHITECTURE.md from the graph |
info |
Show summary information about a TRUG file |
ls |
List directory contents with TRUG metadata |
where |
Search all folder graphs for a concept, node, or file |
find |
Query nodes by type / name / dimension |
add |
Add files to the graph |
mv |
Move/rename a node |
link |
Create or remove typed edges between nodes |
dim |
Manage dimensions |
export |
Export folder.trug.json from the database |
import |
Import folder.trug.json into the database |
Every verb documents examples and exit codes: trug-a-folder <verb> --help.
The language CLI — validating arbitrary TRUG graphs and compiling TRL — is the
sibling package trugs-tools
(binary: trug), which this package builds on.
Lineage
This package descends from the cartography half of trugs-tools 1.0.0; the
2.0 release split it onto its own wheel. History is in
CHANGELOG.md.
License
1 maintainer
Metadata
1 maintainer
Release files for trugs-folder 2.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| trugs_folder-2.2.0.tar.gz | 104.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| trugs_folder-2.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 182.4 kB
Release files / trugs_folder-2.2.0.tar.gz
| Download URL | trugs_folder-2.2.0.tar.gz |
|---|---|
| Size | 104.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a3c8c7bc6ec86678fa335af427be9a62c2e25560e9237f906873aa658ac2967f
|
|
BLAKE2b-256 checksum How to use checksums |
cb2467b8fe8337ceba2e53373ce724d685646cf3451f71647691833d6850fff7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.4
|
Release files / trugs_folder-2.2.0-py3-none-any.whl
| Download URL | trugs_folder-2.2.0-py3-none-any.whl |
|---|---|
| Size | 78.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fbf11ce06c014c3128981242ee4791d73898fa313b209c33f3142228c57e9f07
|
|
BLAKE2b-256 checksum How to use checksums |
2fb24b358d5aff1c35fb39040f87969a2c98eae63505435340b64954f8bfdb68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.4
|
