tcw-cli 2.2.0__tar.gz → 2.4.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tcw_cli-2.4.0/PKG-INFO +1093 -0
- tcw_cli-2.4.0/README.md +877 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/pyproject.toml +2 -2
- tcw_cli-2.4.0/tcw/__init__.py +1 -0
- tcw_cli-2.4.0/tcw/harness.py +104 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/serve/__init__.py +5 -5
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/store/base.py +234 -24
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/store/fs.py +147 -23
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/taxonomy/cli.py +0 -4
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/tracker/claim.py +1 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/tracker/intake.py +21 -5
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/tracker/jira.py +12 -2
- tcw_cli-2.4.0/tcw/tracker/ownership.py +193 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/tracker/progress.py +7 -3
- tcw_cli-2.4.0/tcw/tracker/sync.py +831 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/cli.py +883 -92
- tcw_cli-2.4.0/tcw/work/procedures/audit-backlog.md +125 -0
- tcw_cli-2.4.0/tcw/work/procedures/consolidate-plans.md +35 -0
- tcw_cli-2.4.0/tcw/work/procedures/create-work.md +153 -0
- tcw_cli-2.4.0/tcw/work/procedures/decompose.md +18 -0
- tcw_cli-2.4.0/tcw/work/procedures/delegation.md +26 -0
- tcw_cli-2.4.0/tcw/work/procedures/documentation-sync.md +100 -0
- tcw_cli-2.4.0/tcw/work/procedures/post-mortem.md +41 -0
- tcw_cli-2.4.0/tcw/work/procedures/search.md +75 -0
- tcw_cli-2.4.0/tcw/work/procedures/triage-issues.md +211 -0
- tcw_cli-2.4.0/tcw/work/procedures/unattended-work.md +38 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/projection.py +1 -2
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/prompts/verify.md +0 -2
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/resolve.py +55 -11
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/templates.py +1 -1
- tcw_cli-2.4.0/tcw_cli.egg-info/PKG-INFO +1093 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw_cli.egg-info/SOURCES.txt +25 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_configuration_text_home.py +7 -7
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_documentation_config.py +1 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_documentation_sync_wiring.py +7 -7
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_documented_cli_surface.py +3 -3
- tcw_cli-2.4.0/tests/test_dynamic_skill_marker.py +118 -0
- tcw_cli-2.4.0/tests/test_edit_type.py +127 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_eval_fixture.py +1 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_eval_grading.py +29 -12
- tcw_cli-2.4.0/tests/test_harness.py +65 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_non_git_writes.py +1 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_plugin_manifests.py +94 -40
- tcw_cli-2.4.0/tests/test_procedure_config.py +148 -0
- tcw_cli-2.4.0/tests/test_procedure_verb.py +194 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_repo_lifecycle.py +3 -2
- tcw_cli-2.4.0/tests/test_resolve_procedure.py +79 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_serve_write.py +21 -1
- tcw_cli-2.4.0/tests/test_shipped_procedures.py +165 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_shipped_prompts.py +7 -2
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_skill_flow.py +1 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_skill_lifecycle_parity.py +89 -23
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_skill_path_pointers.py +2 -2
- tcw_cli-2.4.0/tests/test_stage_validate.py +165 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_stage_verb.py +1 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_taxonomy.py +108 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_absent.py +25 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_claim.py +22 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_cli.py +211 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_client.py +13 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_comment.py +21 -3
- tcw_cli-2.4.0/tests/test_tracker_config.py +364 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_help.py +36 -8
- tcw_cli-2.4.0/tests/test_tracker_hold.py +284 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_import.py +109 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_inheritance.py +30 -4
- tcw_cli-2.4.0/tests/test_tracker_ownership.py +289 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_strict.py +127 -7
- tcw_cli-2.4.0/tests/test_tracker_sync.py +2257 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_sync_config.py +1 -1
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_validate.py +31 -1
- tcw_cli-2.4.0/tests/test_unattended_work_skill.py +70 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_work.py +19 -0
- tcw_cli-2.4.0/tests/test_worktree_completion.py +406 -0
- tcw_cli-2.2.0/PKG-INFO +0 -876
- tcw_cli-2.2.0/README.md +0 -660
- tcw_cli-2.2.0/tcw/__init__.py +0 -1
- tcw_cli-2.2.0/tcw/tracker/sync.py +0 -410
- tcw_cli-2.2.0/tcw_cli.egg-info/PKG-INFO +0 -876
- tcw_cli-2.2.0/tests/test_tracker_config.py +0 -191
- tcw_cli-2.2.0/tests/test_tracker_sync.py +0 -965
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/LICENSE +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/setup.cfg +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/capabilities/__init__.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/capabilities/cli.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/cli.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/refs.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/serve/dist/client/assets/index-CCjF_dHr.js +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/serve/dist/client/assets/index-CXNiOIeg.css +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/serve/dist/client/index.html +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/serve/dist/client/theme-init.js +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/serve/dist/server.cjs +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/serve/runtime.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/stdin.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/store/__init__.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/store/checkouts.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/store/project.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/taxonomy/__init__.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/tracker/__init__.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/validate.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/__init__.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/generate.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/hooks.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/prompts/implement.md +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/prompts/inbox.md +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/prompts/plan.md +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/prompts/postmortem.md +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/prompts/request.md +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/prompts/spec.md +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw/work/recursion.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw_cli.egg-info/dependency_links.txt +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw_cli.egg-info/entry_points.txt +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw_cli.egg-info/requires.txt +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tcw_cli.egg-info/top_level.txt +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_body_prompt.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_capabilities.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_capabilities_federation.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_capabilities_reset.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_capabilities_rm.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_capabilities_sidecar.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_capability_ref_wording.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_cli_help_coverage.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_committed_paths.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_cut_version.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_documentation_prompt.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_environment_hardness.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_epic_completable.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_eval_coverage.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_eval_files_changed.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_eval_runner.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_external_work_store.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_falsification_rule.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_generate_hook.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_inbox_title.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_lifecycle_baseline.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_lifecycle_hooks.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_lifecycle_inert.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_lifecycle_policy.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_lifecycle_validation.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_multiproject.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_project_overrides.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_project_registry.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_projection.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_prompt_fallback.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_qualified_ref.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_recursion.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_refs.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_remote_session_setup.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_resolve.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_retention.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_scaffold.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_serve.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_serve_descendants.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_serve_projection.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_serve_resolve.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_serve_runtime.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_session_bootstrap.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_show_json.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_smoke.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_status_parity.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_stdin.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_stdin_cli.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_store_bounds.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_store_editor.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_store_nodes.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_store_provisioning.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_store_publication.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_subprocess_stdin.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tombstone.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_binding.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_claimability.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_link.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_replay.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_tracker_surface.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_unpushed_version_script.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_validate.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_validate_target.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_work_autocommit.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_work_review.py +0 -0
- {tcw_cli-2.2.0 → tcw_cli-2.4.0}/tests/test_work_tags.py +0 -0
tcw_cli-2.4.0/PKG-INFO
ADDED
|
@@ -0,0 +1,1093 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: tcw-cli
|
|
3
|
+
Version: 2.4.0
|
|
4
|
+
Summary: Taxonomy · Capabilities · Work — a storage-abstracted framework for describing and evolving a software project.
|
|
5
|
+
License: Apache License
|
|
6
|
+
Version 2.0, January 2004
|
|
7
|
+
http://www.apache.org/licenses/
|
|
8
|
+
|
|
9
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
10
|
+
|
|
11
|
+
1. Definitions.
|
|
12
|
+
|
|
13
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
14
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
15
|
+
|
|
16
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
17
|
+
the copyright owner that is granting the License.
|
|
18
|
+
|
|
19
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
20
|
+
other entities that control, are controlled by, or are under common
|
|
21
|
+
control with that entity. For the purposes of this definition,
|
|
22
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
23
|
+
direction or management of such entity, whether by contract or
|
|
24
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
25
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
26
|
+
|
|
27
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
28
|
+
exercising permissions granted by this License.
|
|
29
|
+
|
|
30
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
31
|
+
including but not limited to software source code, documentation
|
|
32
|
+
source, and configuration files.
|
|
33
|
+
|
|
34
|
+
"Object" form shall mean any form resulting from mechanical
|
|
35
|
+
transformation or translation of a Source form, including but
|
|
36
|
+
not limited to compiled object code, generated documentation,
|
|
37
|
+
and conversions to other media types.
|
|
38
|
+
|
|
39
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
40
|
+
Object form, made available under the License, as indicated by a
|
|
41
|
+
copyright notice that is included in or attached to the work
|
|
42
|
+
(an example is provided in the Appendix below).
|
|
43
|
+
|
|
44
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
45
|
+
form, that is based on (or derived from) the Work and for which the
|
|
46
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
47
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
48
|
+
of this License, Derivative Works shall not include works that remain
|
|
49
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
50
|
+
the Work and Derivative Works thereof.
|
|
51
|
+
|
|
52
|
+
"Contribution" shall mean any work of authorship, including
|
|
53
|
+
the original version of the Work and any modifications or additions
|
|
54
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
55
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
56
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
57
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
58
|
+
means any form of electronic, verbal, or written communication sent
|
|
59
|
+
to the Licensor or its representatives, including but not limited to
|
|
60
|
+
communication on electronic mailing lists, source code control systems,
|
|
61
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
62
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
63
|
+
excluding communication that is conspicuously marked or otherwise
|
|
64
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
65
|
+
|
|
66
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
67
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
68
|
+
subsequently incorporated within the Work.
|
|
69
|
+
|
|
70
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
71
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
72
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
73
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
74
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
75
|
+
Work and such Derivative Works in Source or Object form.
|
|
76
|
+
|
|
77
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
78
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
79
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
80
|
+
(except as stated in this section) patent license to make, have made,
|
|
81
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
82
|
+
where such license applies only to those patent claims licensable
|
|
83
|
+
by such Contributor that are necessarily infringed by their
|
|
84
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
85
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
86
|
+
institute patent litigation against any entity (including a
|
|
87
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
88
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
89
|
+
or contributory patent infringement, then any patent licenses
|
|
90
|
+
granted to You under this License for that Work shall terminate
|
|
91
|
+
as of the date such litigation is filed.
|
|
92
|
+
|
|
93
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
94
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
95
|
+
modifications, and in Source or Object form, provided that You
|
|
96
|
+
meet the following conditions:
|
|
97
|
+
|
|
98
|
+
(a) You must give any other recipients of the Work or
|
|
99
|
+
Derivative Works a copy of this License; and
|
|
100
|
+
|
|
101
|
+
(b) You must cause any modified files to carry prominent notices
|
|
102
|
+
stating that You changed the files; and
|
|
103
|
+
|
|
104
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
105
|
+
that You distribute, all copyright, patent, trademark, and
|
|
106
|
+
attribution notices from the Source form of the Work,
|
|
107
|
+
excluding those notices that do not pertain to any part of
|
|
108
|
+
the Derivative Works; and
|
|
109
|
+
|
|
110
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
111
|
+
distribution, then any Derivative Works that You distribute must
|
|
112
|
+
include a readable copy of the attribution notices contained
|
|
113
|
+
within such NOTICE file, excluding those notices that do not
|
|
114
|
+
pertain to any part of the Derivative Works, in at least one
|
|
115
|
+
of the following places: within a NOTICE text file distributed
|
|
116
|
+
as part of the Derivative Works; within the Source form or
|
|
117
|
+
documentation, if provided along with the Derivative Works; or,
|
|
118
|
+
within a display generated by the Derivative Works, if and
|
|
119
|
+
wherever such third-party notices normally appear. The contents
|
|
120
|
+
of the NOTICE file are for informational purposes only and
|
|
121
|
+
do not modify the License. You may add Your own attribution
|
|
122
|
+
notices within Derivative Works that You distribute, alongside
|
|
123
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
124
|
+
that such additional attribution notices cannot be construed
|
|
125
|
+
as modifying the License.
|
|
126
|
+
|
|
127
|
+
You may add Your own copyright statement to Your modifications and
|
|
128
|
+
may provide additional or different license terms and conditions
|
|
129
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
130
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
131
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
132
|
+
the conditions stated in this License.
|
|
133
|
+
|
|
134
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
135
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
136
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
137
|
+
this License, without any additional terms or conditions.
|
|
138
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
139
|
+
the terms of any separate license agreement you may have executed
|
|
140
|
+
with Licensor regarding such Contributions.
|
|
141
|
+
|
|
142
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
143
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
144
|
+
except as required for reasonable and customary use in describing the
|
|
145
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
146
|
+
|
|
147
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
148
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
149
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
150
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
151
|
+
implied, including, without limitation, any warranties or conditions
|
|
152
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
153
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
154
|
+
appropriateness of using or redistributing the Work and assume any
|
|
155
|
+
risks associated with Your exercise of permissions under this License.
|
|
156
|
+
|
|
157
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
158
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
159
|
+
unless required by applicable law (such as deliberate and grossly
|
|
160
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
161
|
+
liable to You for damages, including any direct, indirect, special,
|
|
162
|
+
incidental, or consequential damages of any character arising as a
|
|
163
|
+
result of this License or out of the use or inability to use the
|
|
164
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
165
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
166
|
+
other commercial damages or losses), even if such Contributor
|
|
167
|
+
has been advised of the possibility of such damages.
|
|
168
|
+
|
|
169
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
170
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
171
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
172
|
+
or other liability obligations and/or rights consistent with this
|
|
173
|
+
License. However, in accepting such obligations, You may act only
|
|
174
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
175
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
176
|
+
defend, and hold each Contributor harmless for any liability
|
|
177
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
178
|
+
of your accepting any such warranty or additional liability.
|
|
179
|
+
|
|
180
|
+
END OF TERMS AND CONDITIONS
|
|
181
|
+
|
|
182
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
183
|
+
|
|
184
|
+
To apply the Apache License to your work, attach the following
|
|
185
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
186
|
+
replaced with your own identifying information. (Don't include
|
|
187
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
188
|
+
comment syntax for the file format. We also recommend that a
|
|
189
|
+
file or class name and description of purpose be included on the
|
|
190
|
+
same "printed page" as the copyright notice for easier
|
|
191
|
+
identification within third-party archives.
|
|
192
|
+
|
|
193
|
+
Copyright [yyyy] [name of copyright owner]
|
|
194
|
+
|
|
195
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
196
|
+
you may not use this file except in compliance with the License.
|
|
197
|
+
You may obtain a copy of the License at
|
|
198
|
+
|
|
199
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
200
|
+
|
|
201
|
+
Unless required by applicable law or agreed to in writing, software
|
|
202
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
203
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
204
|
+
See the License for the specific language governing permissions and
|
|
205
|
+
limitations under the License.
|
|
206
|
+
|
|
207
|
+
Requires-Python: >=3.11
|
|
208
|
+
Description-Content-Type: text/markdown
|
|
209
|
+
License-File: LICENSE
|
|
210
|
+
Requires-Dist: PyYAML>=6
|
|
211
|
+
Provides-Extra: dev
|
|
212
|
+
Requires-Dist: pytest; extra == "dev"
|
|
213
|
+
Requires-Dist: jsonschema; extra == "dev"
|
|
214
|
+
Requires-Dist: setuptools>=61; extra == "dev"
|
|
215
|
+
Dynamic: license-file
|
|
216
|
+
|
|
217
|
+
# TCW — Taxonomy · Capabilities · Work
|
|
218
|
+
|
|
219
|
+
TCW keeps three things about a software project inside the repository, next to
|
|
220
|
+
the code: what the project deals with, what a user can do with it, and what is
|
|
221
|
+
being changed. One command-line tool, `tcw`, and an agent plugin for Claude Code
|
|
222
|
+
and Codex keep all three in step with the code.
|
|
223
|
+
|
|
224
|
+
| Component | Answers |
|
|
225
|
+
| ---------------- | ------------------------------------------------------- |
|
|
226
|
+
| **Taxonomy** | What things does this project deal with? |
|
|
227
|
+
| **Capabilities** | What can a user do with those things? |
|
|
228
|
+
| **Work** | What are we changing, and where does each change stand? |
|
|
229
|
+
|
|
230
|
+
## Contents
|
|
231
|
+
|
|
232
|
+
- [Problem Statement](#problem-statement)
|
|
233
|
+
- [Installation](#installation)
|
|
234
|
+
- [Plugin](#plugin)
|
|
235
|
+
- [CLI](#cli)
|
|
236
|
+
- [Cloud Environment Instructions](#cloud-environment-instructions)
|
|
237
|
+
- [Overview](#overview)
|
|
238
|
+
- [Taxonomy](#taxonomy)
|
|
239
|
+
- [Overview](#overview-1)
|
|
240
|
+
- [Usage](#usage)
|
|
241
|
+
- [Capabilities](#capabilities)
|
|
242
|
+
- [Overview](#overview-2)
|
|
243
|
+
- [Usage](#usage-1)
|
|
244
|
+
- [Work](#work)
|
|
245
|
+
- [Overview](#overview-3)
|
|
246
|
+
- [Lifecycle](#lifecycle)
|
|
247
|
+
- [Usage](#usage-2)
|
|
248
|
+
- [Skills and Agents](#skills-and-agents)
|
|
249
|
+
- [TCW Local Web App](#tcw-local-web-app)
|
|
250
|
+
- [Documentation](#documentation)
|
|
251
|
+
- [Development](#development)
|
|
252
|
+
- [Setting up](#setting-up)
|
|
253
|
+
- [Running the tests](#running-the-tests)
|
|
254
|
+
- [How work is tracked here](#how-work-is-tracked-here)
|
|
255
|
+
- [Measuring the skill layer](#measuring-the-skill-layer)
|
|
256
|
+
- [Releasing](#releasing)
|
|
257
|
+
- [Reporting problems](#reporting-problems)
|
|
258
|
+
- [License](#license)
|
|
259
|
+
- [Further Reading](#further-reading)
|
|
260
|
+
|
|
261
|
+
## Problem Statement
|
|
262
|
+
|
|
263
|
+
Ask three people at a company with twenty repositories what one of those
|
|
264
|
+
repositories does, what a user can do with it, and what is being changed in it
|
|
265
|
+
right now. You get three different answers, assembled from four different places:
|
|
266
|
+
a ticket tracker that knows about work but not about the product, a wiki whose
|
|
267
|
+
glossary was last edited two years ago, a `FOLLOWUPS.md` that only grows, and
|
|
268
|
+
design documents that stopped matching the code some time back.
|
|
269
|
+
|
|
270
|
+
None of those places is wrong on purpose. They drift because none of them sits
|
|
271
|
+
next to the code, and nothing makes them move when the code moves.
|
|
272
|
+
|
|
273
|
+
TCW puts all three in the repository. One commit carries a code change and the
|
|
274
|
+
description of what it changed, and a reviewer sees both in the same diff.
|
|
275
|
+
|
|
276
|
+
## Installation
|
|
277
|
+
|
|
278
|
+
### Plugin
|
|
279
|
+
|
|
280
|
+
In **Claude Code**:
|
|
281
|
+
|
|
282
|
+
```
|
|
283
|
+
/plugin marketplace add brocef/TCW
|
|
284
|
+
/plugin install tcw
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
Or, in the Claude **web app** or **desktop app**, open the plugin directory, add
|
|
288
|
+
`brocef/TCW` as a marketplace, and install `tcw` from it — no terminal needed.
|
|
289
|
+
|
|
290
|
+
**Then start a new session.** The plugin installs the `tcw` CLI at session start
|
|
291
|
+
by installing `tcw-cli` from PyPI with `pipx`, so one installed mid-session
|
|
292
|
+
cannot run until the next one begins. That first session needs network access. It
|
|
293
|
+
installs over an existing `pipx install tcw-cli` rather than beside it, and
|
|
294
|
+
leaves a development checkout (`pip install -e .`) alone. If `tcw` goes missing
|
|
295
|
+
anyway, `pipx install tcw-cli` is the whole fix — the **`setup`** skill
|
|
296
|
+
carries the cases where it is not.
|
|
297
|
+
|
|
298
|
+
In **Codex**:
|
|
299
|
+
|
|
300
|
+
```bash
|
|
301
|
+
codex plugin marketplace add brocef/TCW --ref main
|
|
302
|
+
codex plugin add tcw@tcw
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
Codex has no session-start hook, so ask the agent to run the **`setup`**
|
|
306
|
+
skill — it runs the same install script Claude runs automatically.
|
|
307
|
+
|
|
308
|
+
The plugin ships the skills and read-only review agents described in
|
|
309
|
+
[Skills and Agents](#skills-and-agents).
|
|
310
|
+
|
|
311
|
+
### CLI
|
|
312
|
+
|
|
313
|
+
```sh
|
|
314
|
+
pipx install tcw-cli
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
Use this when you want the CLI without an agent harness at all. The PyPI package
|
|
318
|
+
is named **`tcw-cli`** because `tcw` was taken by an unrelated project; the
|
|
319
|
+
command it installs is still `tcw`.
|
|
320
|
+
|
|
321
|
+
Requires **Python ≥ 3.11** (its only runtime dependency is PyYAML). `tcw serve`
|
|
322
|
+
additionally requires **Node.js ≥ 22.12**; every other command is Python-only.
|
|
323
|
+
Released wheels carry the prebuilt web assets, so there is no frontend build step
|
|
324
|
+
and no network needed after install.
|
|
325
|
+
|
|
326
|
+
### Cloud Environment Instructions
|
|
327
|
+
|
|
328
|
+
A cloud agent session — Claude Code on the web, a Codex cloud task, a CI job —
|
|
329
|
+
starts from a clean image and is thrown away when it ends, so a `tcw` you install
|
|
330
|
+
by hand is gone by the next one. Install it as part of the environment's own
|
|
331
|
+
setup, and every session gets it without anyone remembering to.
|
|
332
|
+
|
|
333
|
+
**Claude Code on the web.** Add a script to your repository:
|
|
334
|
+
|
|
335
|
+
```sh
|
|
336
|
+
#!/usr/bin/env bash
|
|
337
|
+
# Make `tcw` available in a disposable agent container.
|
|
338
|
+
# Exit 0 on every path — a session must start even when this cannot finish.
|
|
339
|
+
set -u
|
|
340
|
+
|
|
341
|
+
command -v tcw >/dev/null 2>&1 && exit 0
|
|
342
|
+
|
|
343
|
+
# pipx where it exists; otherwise install into the container's own interpreter.
|
|
344
|
+
# That is the right answer *here* and nowhere else: the container is disposable
|
|
345
|
+
# and single-purpose, so there is no user environment to damage.
|
|
346
|
+
if command -v pipx >/dev/null 2>&1; then
|
|
347
|
+
pipx install tcw-cli >/dev/null 2>&1 || echo "tcw: pipx install tcw-cli failed"
|
|
348
|
+
elif ! python3 -m pip install tcw-cli >/dev/null 2>&1 &&
|
|
349
|
+
! python3 -m pip install tcw-cli --break-system-packages >/dev/null 2>&1; then
|
|
350
|
+
echo "tcw: pip install tcw-cli failed — the tcw CLI is not available."
|
|
351
|
+
fi
|
|
352
|
+
|
|
353
|
+
# An install that landed outside PATH is installed and unusable. $CLAUDE_ENV_FILE
|
|
354
|
+
# is the harness's own channel for repairing that.
|
|
355
|
+
if ! command -v tcw >/dev/null 2>&1 && [ -n "${CLAUDE_ENV_FILE:-}" ]; then
|
|
356
|
+
userbin="$(python3 -m site --user-base 2>/dev/null)/bin"
|
|
357
|
+
[ -x "$userbin/tcw" ] && echo "export PATH=\"$userbin:\$PATH\"" >>"$CLAUDE_ENV_FILE"
|
|
358
|
+
fi
|
|
359
|
+
|
|
360
|
+
exit 0
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
Then wire it to `SessionStart` in your repository's `.claude/settings.json`:
|
|
364
|
+
|
|
365
|
+
```json
|
|
366
|
+
{
|
|
367
|
+
"hooks": {
|
|
368
|
+
"SessionStart": [
|
|
369
|
+
{
|
|
370
|
+
"hooks": [
|
|
371
|
+
{
|
|
372
|
+
"type": "command",
|
|
373
|
+
"command": "\"${CLAUDE_PROJECT_DIR}\"/scripts/tcw_session_setup.sh"
|
|
374
|
+
}
|
|
375
|
+
]
|
|
376
|
+
}
|
|
377
|
+
]
|
|
378
|
+
}
|
|
379
|
+
}
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
Three things make the difference between a hook that helps and one that wastes a
|
|
383
|
+
session:
|
|
384
|
+
|
|
385
|
+
- **Exit 0 on every path, and print only on failure.** A hook that fails the
|
|
386
|
+
session start over a missing CLI has cost more than the CLI was worth.
|
|
387
|
+
- **Print to stdout.** Claude Code adds a `SessionStart` hook's stdout to the
|
|
388
|
+
agent's context, where it will be read; stderr becomes a transcript notice
|
|
389
|
+
nobody sees.
|
|
390
|
+
- **Check for `tcw` first.** The hook runs every session, including the ones
|
|
391
|
+
where a previous install is still there.
|
|
392
|
+
|
|
393
|
+
**Codex cloud.** A Codex cloud environment does not read a hook from your
|
|
394
|
+
repository. Its install steps go in the environment's **setup script**, which you
|
|
395
|
+
set in the environment's settings. Two things differ from Claude Code:
|
|
396
|
+
|
|
397
|
+
- **The setup script has internet access; the agent does not, by default.**
|
|
398
|
+
Install `tcw` in the setup script, not by asking the agent to do it later.
|
|
399
|
+
- **The setup script runs in its own shell**, so an `export` there never reaches
|
|
400
|
+
the agent. Repair `PATH` by writing to `~/.bashrc` instead.
|
|
401
|
+
|
|
402
|
+
```sh
|
|
403
|
+
if ! command -v tcw >/dev/null 2>&1; then
|
|
404
|
+
if command -v pipx >/dev/null 2>&1; then
|
|
405
|
+
pipx install tcw-cli
|
|
406
|
+
else
|
|
407
|
+
python3 -m pip install tcw-cli || python3 -m pip install tcw-cli --break-system-packages
|
|
408
|
+
fi
|
|
409
|
+
fi
|
|
410
|
+
|
|
411
|
+
# An install that landed outside PATH: make the agent's shell find it.
|
|
412
|
+
userbin="$(python3 -m site --user-base 2>/dev/null)/bin"
|
|
413
|
+
if ! command -v tcw >/dev/null 2>&1 && [ -x "$userbin/tcw" ]; then
|
|
414
|
+
echo "export PATH=\"$userbin:\$PATH\"" >>~/.bashrc
|
|
415
|
+
fi
|
|
416
|
+
```
|
|
417
|
+
|
|
418
|
+
**If your work store lives in another repository**, the container holds only the
|
|
419
|
+
repository it cloned, so its work items are declared but absent. Run `tcw provision`
|
|
420
|
+
after the install — it obtains what the checkout does not have, and does nothing
|
|
421
|
+
on a machine that already holds it. See
|
|
422
|
+
[Working across repositories](docs/guide/multi-repo.md).
|
|
423
|
+
|
|
424
|
+
Installing the **plugin** in a Claude Code session is a separate step from
|
|
425
|
+
installing the CLI, and only needed where the harness does not carry your plugins
|
|
426
|
+
in: append `claude plugin marketplace add brocef/TCW` and
|
|
427
|
+
`claude plugin install tcw@tcw` to the same script, guarded on `command -v claude`.
|
|
428
|
+
|
|
429
|
+
## Overview
|
|
430
|
+
|
|
431
|
+
TCW describes a project along three axes. **Taxonomy** is the project's
|
|
432
|
+
vocabulary and its features. **Capabilities** are the things a user can do,
|
|
433
|
+
each with a status. **Work** is the set of changes being made, each moving through
|
|
434
|
+
a lifecycle. The three link by one-directional pointers: a capability names the
|
|
435
|
+
taxonomy entries it involves, and a work item names the capabilities it changes.
|
|
436
|
+
None of them copies another's content.
|
|
437
|
+
|
|
438
|
+
Everything is plain files in the repository, so a code change and the
|
|
439
|
+
description of what it changed travel in the same commit and the same pull
|
|
440
|
+
request. A work item's status is the folder it sits in, so there is no separate
|
|
441
|
+
list to fall out of step. Each item is addressed by its **slug**, a dated short
|
|
442
|
+
name such as `2026-09-15-export-invoices-as-pdf`.
|
|
443
|
+
|
|
444
|
+
**One command-line tool, `tcw`**, does everything:
|
|
445
|
+
|
|
446
|
+
| Command | What it does |
|
|
447
|
+
| ------------------ | ----------------------------------------------------------------------------- |
|
|
448
|
+
| `tcw init` | marks a directory as a TCW project and creates the folders for each axis |
|
|
449
|
+
| `tcw provision` | fetches a work store this project declares but this machine does not have |
|
|
450
|
+
| `tcw validate` | checks every file, reference and link across the project and its sub-projects |
|
|
451
|
+
| `tcw serve` | starts a local web app for browsing and editing all three axes |
|
|
452
|
+
| `tcw taxonomy` | the vocabulary and features |
|
|
453
|
+
| `tcw capabilities` | what a user can do |
|
|
454
|
+
| `tcw work` | the changes, and the lifecycle each one follows |
|
|
455
|
+
|
|
456
|
+
A repository adopts TCW with one command, run inside a git repository:
|
|
457
|
+
|
|
458
|
+
```sh
|
|
459
|
+
tcw init --id my-project # all three axes
|
|
460
|
+
tcw init --id my-project taxonomy work # …or only some of them
|
|
461
|
+
```
|
|
462
|
+
|
|
463
|
+
That writes a `tcw-config.yaml` holding the project's ID and creates the folders
|
|
464
|
+
under `docs/`. A project can adopt the work axis alone and add the others later.
|
|
465
|
+
`tcw validate` exits non-zero on any problem, so it works as a check in CI.
|
|
466
|
+
|
|
467
|
+
**The CLI enforces the rules; the agent plugin supplies the judgment.** Legal
|
|
468
|
+
status changes, references that must resolve, and the checks before an item can
|
|
469
|
+
be completed are enforced by `tcw` itself. Deciding what a request means, writing
|
|
470
|
+
a spec, or judging whether work is finished is what the plugin's skills guide an
|
|
471
|
+
agent through. See [Skills and Agents](#skills-and-agents).
|
|
472
|
+
|
|
473
|
+
**Many repositories, one model.** Projects are identified by ID, never by path.
|
|
474
|
+
A project can connect to others, inherit their taxonomy and capabilities, and
|
|
475
|
+
address their work items as `<project-id>/<slug>`. A checkout holding only some of
|
|
476
|
+
the connected repositories still works: the absent ones drop out rather than
|
|
477
|
+
breaking your commands. See [Working across repositories](docs/guide/multi-repo.md).
|
|
478
|
+
|
|
479
|
+
## Taxonomy
|
|
480
|
+
|
|
481
|
+
### Overview
|
|
482
|
+
|
|
483
|
+
A taxonomy entry has one of two kinds. **Vocabulary** entries are the project's
|
|
484
|
+
basic language: `Invoice`, `Customer`, `Permission`. **Feature** entries are the
|
|
485
|
+
user- or application-facing parts that operate on that vocabulary, and each names
|
|
486
|
+
the vocabulary entries it involves. A feature can only name vocabulary that
|
|
487
|
+
already exists, so vocabulary is registered first.
|
|
488
|
+
|
|
489
|
+
Entries form a tree, and an entry's path is its address: `admin/permission` and
|
|
490
|
+
`billing/permission` are two different entries.
|
|
491
|
+
|
|
492
|
+
A project can **inherit** another project's taxonomy. Inherited entries keep the
|
|
493
|
+
other project's ID as a prefix, so an inherited `acme/permission` never quietly
|
|
494
|
+
becomes your own `permission`.
|
|
495
|
+
|
|
496
|
+
### Usage
|
|
497
|
+
|
|
498
|
+
#### Skills
|
|
499
|
+
|
|
500
|
+
| Skill | What it does |
|
|
501
|
+
| -------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
502
|
+
| [`taxonomy`](skills/taxonomy/SKILL.md) | Guides an agent through declaring vocabulary and features, linking them, and resolving inherited entries. |
|
|
503
|
+
|
|
504
|
+
To draft a first taxonomy from an existing codebase, use the `setup` skill
|
|
505
|
+
described in [Skills and Agents](#skills-and-agents).
|
|
506
|
+
|
|
507
|
+
#### CLI
|
|
508
|
+
|
|
509
|
+
| Command | What it does |
|
|
510
|
+
| ---------------------- | --------------------------------------------------------------------- |
|
|
511
|
+
| `tcw taxonomy init` | creates `docs/taxonomy/` (the same as `tcw init taxonomy`) |
|
|
512
|
+
| `tcw taxonomy list` | shows every entry as a tree, marked by kind and by where it came from |
|
|
513
|
+
| `tcw taxonomy add` | creates a vocabulary entry or a feature |
|
|
514
|
+
| `tcw taxonomy show` | prints one entry |
|
|
515
|
+
| `tcw taxonomy path` | prints the folder the taxonomy is stored in |
|
|
516
|
+
| `tcw taxonomy rm` | removes a local entry nothing is nested under or refers to |
|
|
517
|
+
| `tcw taxonomy search` | searches entry names and descriptions |
|
|
518
|
+
| `tcw taxonomy check` | checks that every reference and inherited project resolves |
|
|
519
|
+
| `tcw taxonomy extends` | adds or removes a project whose taxonomy this one inherits |
|
|
520
|
+
|
|
521
|
+
```sh
|
|
522
|
+
tcw taxonomy add Invoice "A bill issued to a customer." # vocabulary by default
|
|
523
|
+
tcw taxonomy add Admin "Running the service."
|
|
524
|
+
tcw taxonomy add Permission -p admin # → admin/permission
|
|
525
|
+
tcw taxonomy add "PDF Export" --kind feature --vocab invoice
|
|
526
|
+
tcw taxonomy list
|
|
527
|
+
tcw taxonomy extends add acme-shared # inherit another project
|
|
528
|
+
```
|
|
529
|
+
|
|
530
|
+
More in [Taxonomy and Capabilities](docs/guide/taxonomy-and-capabilities.md).
|
|
531
|
+
|
|
532
|
+
## Capabilities
|
|
533
|
+
|
|
534
|
+
### Overview
|
|
535
|
+
|
|
536
|
+
A capability is one thing a user can do, such as "Download an invoice as PDF".
|
|
537
|
+
Each is addressed by a path (`billing/invoices`), gets a stable ID when created,
|
|
538
|
+
and carries a **status**: `Supported`, `Partial`, `Missing`, `Blocked` or
|
|
539
|
+
`Omitted`. The status is what makes the list useful: it says what the product
|
|
540
|
+
actually does today, and completing a work item is how a capability moves from
|
|
541
|
+
`Missing` to `Supported`.
|
|
542
|
+
|
|
543
|
+
Capabilities can be **inherited** from another project. A web frontend and a
|
|
544
|
+
mobile app that drive the same server declare their shared capabilities once, and
|
|
545
|
+
each **overrides** only what differs, for example marking one `Omitted` or adding
|
|
546
|
+
to its description. An override can be undone to go back to the inherited
|
|
547
|
+
version.
|
|
548
|
+
|
|
549
|
+
#### Relationship to Taxonomy
|
|
550
|
+
|
|
551
|
+
A capability points at taxonomy, never the other way. Its `Subject` field names
|
|
552
|
+
the vocabulary entries it involves (any number of them), and its `Feature` field
|
|
553
|
+
names the taxonomy feature that delivers it. TCW checks that both resolve, and
|
|
554
|
+
refuses to save a capability whose references do not, so a feature is
|
|
555
|
+
registered in the taxonomy before a capability names it.
|
|
556
|
+
|
|
557
|
+
### Usage
|
|
558
|
+
|
|
559
|
+
#### Skills
|
|
560
|
+
|
|
561
|
+
| Skill | What it does |
|
|
562
|
+
| ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
563
|
+
| [`capabilities`](skills/capabilities/SKILL.md) | Guides an agent through checking a planned change against the existing capabilities, catching contradictions, and updating a capability's status when work completes. |
|
|
564
|
+
|
|
565
|
+
#### CLI
|
|
566
|
+
|
|
567
|
+
| Command | What it does |
|
|
568
|
+
| -------------------------- | ------------------------------------------------------------------------------------------- |
|
|
569
|
+
| `tcw capabilities init` | creates `docs/capabilities/` (the same as `tcw init capabilities`) |
|
|
570
|
+
| `tcw capabilities list` | lists capabilities, marked by status and by where they came from |
|
|
571
|
+
| `tcw capabilities show` | prints one capability |
|
|
572
|
+
| `tcw capabilities path` | prints the folder capabilities are stored in |
|
|
573
|
+
| `tcw capabilities add` | creates a capability |
|
|
574
|
+
| `tcw capabilities set` | changes a capability's status or fields; on an inherited one, writes an override |
|
|
575
|
+
| `tcw capabilities reset` | removes a local override, going back to the inherited version |
|
|
576
|
+
| `tcw capabilities rm` | removes a local capability |
|
|
577
|
+
| `tcw capabilities search` | searches names and descriptions |
|
|
578
|
+
| `tcw capabilities extends` | adds or removes a project whose capabilities this one inherits |
|
|
579
|
+
| `tcw capabilities check` | checks paths, fields, taxonomy references and inheritance |
|
|
580
|
+
| `tcw capabilities drift` | reports inherited capabilities nobody has reviewed, and shipped work still marked `Missing` |
|
|
581
|
+
|
|
582
|
+
```sh
|
|
583
|
+
tcw capabilities add billing/invoices "Download an invoice as PDF"
|
|
584
|
+
tcw capabilities set billing/invoices --field "Subject=invoice" --field "Feature=pdf-export"
|
|
585
|
+
tcw capabilities list --status Missing
|
|
586
|
+
tcw capabilities set billing/invoices --status Supported
|
|
587
|
+
tcw capabilities extends web-frontend # inherit another project
|
|
588
|
+
```
|
|
589
|
+
|
|
590
|
+
More in [Taxonomy and Capabilities](docs/guide/taxonomy-and-capabilities.md).
|
|
591
|
+
|
|
592
|
+
## Work
|
|
593
|
+
|
|
594
|
+
### Overview
|
|
595
|
+
|
|
596
|
+
The work axis tracks every change being made to the project: new product
|
|
597
|
+
behavior, changes to its internals, or changes to how the project itself runs.
|
|
598
|
+
|
|
599
|
+
- **A work item is a folder**, `docs/work/<status>/<slug>/`, holding the
|
|
600
|
+
documents written for it as it moves along. **Its status is the folder it is
|
|
601
|
+
in**: moving an item is a `git mv`, and `ls docs/work/active/` is the board of
|
|
602
|
+
what is in progress. By default, every status change commits itself.
|
|
603
|
+
- **Requests start in an inbox.** A raw request dropped into `docs/work/inbox/`,
|
|
604
|
+
by a person or by another project, becomes a work item when it is accepted.
|
|
605
|
+
A Jira ticket can instead become an item directly (see
|
|
606
|
+
[Jira integration](#jira-integration)).
|
|
607
|
+
- **Tags** come from a list the project registers (`tcw work tags`), so a typo
|
|
608
|
+
never quietly creates a new tag.
|
|
609
|
+
- **Blockers** are recorded on an item (`tcw work edit --blocked-by`). An item
|
|
610
|
+
with an unresolved blocker cannot start, or be completed as done, without
|
|
611
|
+
`--force`; there is no separate "blocked" status.
|
|
612
|
+
- **Large items split.** A child item lives inside its parent's folder and moves
|
|
613
|
+
with it. An **epic** groups related items, including items in other
|
|
614
|
+
repositories, and reports their combined status.
|
|
615
|
+
- **Completing is checked.** `tcw work complete` prints the project's Definition
|
|
616
|
+
of Done (a list you set in `docs/work/dod.yaml`) and refuses until you confirm
|
|
617
|
+
it, while blockers are unresolved, or while declared capability changes are not
|
|
618
|
+
yet made.
|
|
619
|
+
- **Code can be isolated.** `tcw work start --worktree` gives the item its own git
|
|
620
|
+
branch and worktree, and `complete` merges it back.
|
|
621
|
+
|
|
622
|
+
The full reference, including every command's options, is
|
|
623
|
+
[The Work component](docs/guide/work.md).
|
|
624
|
+
|
|
625
|
+
#### Relationship to Capabilities and Taxonomy
|
|
626
|
+
|
|
627
|
+
A work item that changes what a user can do says so in a `capabilities.yaml` file
|
|
628
|
+
in its folder, listing capability paths under `new:`, `changed:` and `removed:`.
|
|
629
|
+
That is the pointer from work to capabilities. `tcw work complete` refuses while
|
|
630
|
+
a capability listed as `new:` is still `Missing`, a listed path does not exist,
|
|
631
|
+
or a `removed:` capability is still there. So the capabilities list always
|
|
632
|
+
describes what has actually shipped.
|
|
633
|
+
|
|
634
|
+
Work reaches taxonomy through those capabilities: a new capability names the
|
|
635
|
+
vocabulary and feature it involves, and those entries must exist first. The
|
|
636
|
+
planning skills check both, in that order (vocabulary, then features, then
|
|
637
|
+
capabilities, then the work itself), before a change is designed.
|
|
638
|
+
|
|
639
|
+
### Lifecycle
|
|
640
|
+
|
|
641
|
+
TCW's lifecycle has two separate parts. **Stages** produce documents: `request`
|
|
642
|
+
writes `initial-request.md`, `spec` writes `spec.md`, and so on. **Transitions**
|
|
643
|
+
move an item from one status to another. Nothing is both. In words: an inbox
|
|
644
|
+
entry is accepted into the backlog, where the request, spec and plan are written;
|
|
645
|
+
`start` moves it to active for implementation; `submit` moves it to review for
|
|
646
|
+
verification, from which `rework` can send it back; and `complete` finishes it as
|
|
647
|
+
completed, or as discarded if it will not ship.
|
|
648
|
+
|
|
649
|
+
```mermaid
|
|
650
|
+
%%{init: {"themeVariables": {"edgeLabelBackground": "#b45309", "textColor": "#ffffff"}}}%%
|
|
651
|
+
flowchart LR
|
|
652
|
+
inbox(["inbox entry<br/><i>stage: inbox</i>"]):::outside
|
|
653
|
+
backlog("backlog<br/><i>stages: request, spec, plan</i>"):::status
|
|
654
|
+
active("active<br/><i>stage: implement</i>"):::status
|
|
655
|
+
review("review<br/><i>stages: verify, postmortem</i>"):::status
|
|
656
|
+
completed("completed<br/><i>stage: postmortem</i>"):::terminal
|
|
657
|
+
discarded("discarded"):::terminal
|
|
658
|
+
removed(["removed"]):::outside
|
|
659
|
+
|
|
660
|
+
inbox -->|inbox accept| backlog
|
|
661
|
+
backlog -->|start| active
|
|
662
|
+
active -->|submit| review
|
|
663
|
+
review -.->|rework| active
|
|
664
|
+
active -->|complete| completed
|
|
665
|
+
review -->|complete| completed
|
|
666
|
+
backlog -->|discard| discarded
|
|
667
|
+
active -->|discard| discarded
|
|
668
|
+
review -->|discard| discarded
|
|
669
|
+
backlog -.->|drop| removed
|
|
670
|
+
completed -.->|not retained| removed
|
|
671
|
+
discarded -.->|not retained| removed
|
|
672
|
+
|
|
673
|
+
classDef status fill:#1d4ed8,stroke:#93c5fd,stroke-width:2px,color:#ffffff
|
|
674
|
+
classDef terminal fill:#1d4ed8,stroke:#93c5fd,stroke-width:4px,color:#ffffff
|
|
675
|
+
classDef outside fill:#6b7280,stroke:#d1d5db,stroke-width:2px,stroke-dasharray:5 4,color:#ffffff
|
|
676
|
+
linkStyle default stroke:#d97706,stroke-width:2px
|
|
677
|
+
```
|
|
678
|
+
|
|
679
|
+
The stages, and the document each one writes:
|
|
680
|
+
|
|
681
|
+
| Stage | Runs while the item is | Writes |
|
|
682
|
+
| ------------ | ---------------------- | ----------------------------------------------------------------- |
|
|
683
|
+
| `inbox` | not yet an item | nothing; it creates the item, keeping the raw text as `intake.md` |
|
|
684
|
+
| `request` | backlog | `initial-request.md`: what is asked for, and why |
|
|
685
|
+
| `spec` | backlog | `spec.md`: what to build, with acceptance criteria |
|
|
686
|
+
| `plan` | backlog | `plan.md`: how to build it, as ordered tasks |
|
|
687
|
+
| `implement` | active | `outcome.md`: what was built, and what the plan got wrong |
|
|
688
|
+
| `verify` | review (or active) | `refined-outcome.md` if accepted, `rework.md` if not |
|
|
689
|
+
| `postmortem` | review or completed | `post-mortem.md`: which stage could first have caught a problem |
|
|
690
|
+
|
|
691
|
+
The transitions, and what each one checks before it moves an item:
|
|
692
|
+
|
|
693
|
+
| Transition | Command | Moves | Refuses when |
|
|
694
|
+
| ------------ | -------------------------------------------------------------------------------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
695
|
+
| `start` | `tcw work start <slug>` | backlog → active | a blocker is unresolved; the item belongs to an epic that is not active |
|
|
696
|
+
| `submit` | `tcw work submit <slug>` | active → review | never |
|
|
697
|
+
| `rework` | `tcw work rework <slug>` | review → active | `refined-outcome.md` is present (it says the work was accepted) |
|
|
698
|
+
| `complete` | `tcw work complete <slug> --resolution done --confirm` | review or active → completed | a blocker is unresolved; an epic has open children; declared capabilities are not reconciled; a worktree merge-back fails; the item's folder in its worktree has uncommitted changes; no `--confirm` |
|
|
699
|
+
| discard | `tcw work complete <slug> --resolution wontfix\|duplicate\|superseded --confirm` | backlog, active or review → discarded | no `--confirm` |
|
|
700
|
+
| `drop` | `tcw work drop <slug> --confirm` | backlog → removed | the item is not in backlog; no `--confirm` |
|
|
701
|
+
| not retained | happens during `complete` or discard | completed or discarded → removed | only happens when `work.retain` says that status is not kept; `tcw work delete` finishes one that was interrupted |
|
|
702
|
+
|
|
703
|
+
`review` means implemented but not yet accepted: an item in review still blocks
|
|
704
|
+
the items that depend on it. `rework` is the only move backwards, and nothing ever
|
|
705
|
+
leaves `completed` or `discarded`.
|
|
706
|
+
|
|
707
|
+
A project can attach its own instructions and checks to any stage or transition,
|
|
708
|
+
such as a design rule read at `spec` or `tcw validate` run before `complete`. See
|
|
709
|
+
[Configuration](docs/guide/configuration.md). `tcw work lifecycle` prints the
|
|
710
|
+
whole contract, with whatever the project has attached.
|
|
711
|
+
|
|
712
|
+
Some of TCW's other instructions can be replaced the same way: how to work items
|
|
713
|
+
unattended, triage issues, keep documentation in sync, and seven more.
|
|
714
|
+
`tcw work procedure prompt <id>` prints one of them, and a project replaces or
|
|
715
|
+
adds to its text under `work.procedures` in `tcw-config.yaml`.
|
|
716
|
+
|
|
717
|
+
#### Jira integration
|
|
718
|
+
|
|
719
|
+
A project can name the Jira Cloud site its team works from. Tickets can then
|
|
720
|
+
become work items, and a ticket linked to an item follows it through the
|
|
721
|
+
lifecycle. None of the stages change: Jira attaches to how an item is created and
|
|
722
|
+
to the transitions.
|
|
723
|
+
|
|
724
|
+
| Lifecycle step | Without Jira | With Jira configured |
|
|
725
|
+
| --------------------------------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
726
|
+
| an item is created | `tcw work inbox accept`, `new` | `tcw work tracker import <ticket>` claims the ticket (starts it and assigns it to you), then creates a backlog item whose intake is the ticket. With `inbox-query` set, `tcw work inbox accept <ticket>` does the same |
|
|
727
|
+
| `request`, `spec`, `plan` stages | unchanged | unchanged |
|
|
728
|
+
| at any time | — | `tcw work tracker link` / `unlink` records or removes the link between an existing item and a ticket; Jira itself is not touched |
|
|
729
|
+
| `start` | moves the item | also claims a linked ticket, and posts a comment if `comments: true` |
|
|
730
|
+
| `submit`, `rework`, `complete`, discard | moves the item | also moves a linked ticket to the Jira status mapped under `statuses`, and posts a comment if `comments: true` |
|
|
731
|
+
| the ticket could not follow | — | the item still moves; the command exits 1 and records the ticket as pending or conflicting; `tcw work tracker sync` retries |
|
|
732
|
+
| the ticket is behind its item | — | with `tcw work tracker link --sync-status`, a ticket linked to work already under way is claimed and moved forward to where the item is |
|
|
733
|
+
| the ticket does not match its item | — | `tcw work tracker sync <slug>` puts it where the item's status says, whether the ticket is ahead of the item or behind it; a backwards move says so |
|
|
734
|
+
|
|
735
|
+
Setting `strict: true` changes several steps, so that no work happens without a
|
|
736
|
+
claimed ticket:
|
|
737
|
+
|
|
738
|
+
- `tcw work new` (except `--epic`) and `inbox accept` of an inbox entry are refused,
|
|
739
|
+
and point you at `tcw work tracker import`. Where `inbox-query` is set, `inbox accept`
|
|
740
|
+
of a ticket is allowed, because it claims the ticket.
|
|
741
|
+
- `start` refuses an item with no ticket. For a linked item it claims the ticket
|
|
742
|
+
first, and moves the item only if the claim worked.
|
|
743
|
+
- `submit`, `rework` and `complete --resolution done` read the ticket first, and
|
|
744
|
+
refuse unless it is assigned to you and where the item's last move left it.
|
|
745
|
+
- Discarding is always allowed. `drop` refuses an item that was ever linked, so
|
|
746
|
+
the record stays.
|
|
747
|
+
- While Jira cannot be reached, those commands refuse, and `tcw serve` refuses
|
|
748
|
+
the same changes.
|
|
749
|
+
|
|
750
|
+
A minimal configuration, in the project's `tcw-config.yaml`:
|
|
751
|
+
|
|
752
|
+
```yaml
|
|
753
|
+
work:
|
|
754
|
+
tracker:
|
|
755
|
+
provider: jira-cloud
|
|
756
|
+
base-url: https://yourcompany.atlassian.net
|
|
757
|
+
candidate-query: assignee = currentUser() AND status = "To Do"
|
|
758
|
+
credentials:
|
|
759
|
+
email-env: TCW_JIRA_EMAIL
|
|
760
|
+
token-env: TCW_JIRA_API_TOKEN
|
|
761
|
+
transitions: { start: Start Progress }
|
|
762
|
+
statuses: { active: In Progress, review: In Review, completed: Done }
|
|
763
|
+
inbox-query: project = ENG AND status = Triage # optional
|
|
764
|
+
```
|
|
765
|
+
|
|
766
|
+
`candidate-query` selects the tickets ready for you to take, and `tcw work tracker
|
|
767
|
+
list` shows them. The optional `inbox-query` selects the tickets still waiting to be
|
|
768
|
+
triaged. When it is set, `tcw work inbox list` prints two sections, `raw intake:` and
|
|
769
|
+
`tracker tickets:`, so triage works from one list. `tcw work inbox show` and
|
|
770
|
+
`inbox accept` then take a ticket key as well as an inbox entry: an inbox entry with
|
|
771
|
+
the same name wins, and `--ticket` reads the name as a ticket anyway. Accepting a
|
|
772
|
+
ticket claims it, exactly as `tcw work tracker import` does. Write the query so it
|
|
773
|
+
leaves out tickets that already have a work item; TCW does not filter them.
|
|
774
|
+
|
|
775
|
+
The credentials entries hold the **names** of environment variables, never the
|
|
776
|
+
e-mail address or token themselves.
|
|
777
|
+
|
|
778
|
+
**Example 1: taking a ticket from import to completion.**
|
|
779
|
+
|
|
780
|
+
```sh
|
|
781
|
+
tcw work tracker list # TCW: lists tickets the query selects. Jira: unchanged
|
|
782
|
+
tcw work tracker import ENG-482 # TCW: creates a backlog item. Jira: ENG-482 → In Progress, assigned to you
|
|
783
|
+
# …the request, spec and plan stages run as usual…
|
|
784
|
+
tcw work start <slug> # TCW: backlog → active. Jira: confirms the claim import made
|
|
785
|
+
tcw work submit <slug> # TCW: active → review. Jira: ENG-482 → In Review
|
|
786
|
+
tcw work complete <slug> --resolution done --confirm
|
|
787
|
+
# TCW: review → completed. Jira: ENG-482 → Done
|
|
788
|
+
```
|
|
789
|
+
|
|
790
|
+
**Example 2: linking an item that already exists.**
|
|
791
|
+
|
|
792
|
+
```sh
|
|
793
|
+
tcw work new "Speed up the checkout page" # TCW: creates a backlog item. Jira: unchanged
|
|
794
|
+
tcw work tracker link <slug> ENG-517 # TCW: records the link. Jira: unchanged; the ticket keeps its assignee
|
|
795
|
+
tcw work start <slug> # TCW: backlog → active. Jira: if unassigned or yours, ENG-517 → In Progress, assigned to you
|
|
796
|
+
```
|
|
797
|
+
|
|
798
|
+
**Example 3: taking a ticket without starting it, and handing it back.**
|
|
799
|
+
|
|
800
|
+
```sh
|
|
801
|
+
tcw work tracker claim <slug> # TCW: records you as the owner. Jira: ENG-517 assigned to you; status unchanged
|
|
802
|
+
# …you decide it is not yours after all…
|
|
803
|
+
tcw work tracker release <slug> # TCW: clears the owner. Jira: ENG-517 unassigned; status unchanged
|
|
804
|
+
```
|
|
805
|
+
|
|
806
|
+
Neither command moves anything. Claiming an item already under way is how you
|
|
807
|
+
take work over; releasing one is how you hand it on, and it stays where it is
|
|
808
|
+
until somebody else claims it.
|
|
809
|
+
|
|
810
|
+
**Example 4: the same project with `strict: true`.**
|
|
811
|
+
|
|
812
|
+
```sh
|
|
813
|
+
tcw work new "Speed up the checkout page"
|
|
814
|
+
# tcw work new: refused under strict tracker mode; nothing was created.
|
|
815
|
+
# Create work from a ticket with `tcw work tracker import <ticket>`.
|
|
816
|
+
tcw work tracker import ENG-517 # the only way to create the item
|
|
817
|
+
tcw work start <slug> # claims first; starts only if the claim worked
|
|
818
|
+
```
|
|
819
|
+
|
|
820
|
+
Configuration, settings shared from a parent project, what `tracker show`
|
|
821
|
+
reports, comments, and the known limits are in
|
|
822
|
+
[Working from Jira](docs/guide/jira.md).
|
|
823
|
+
|
|
824
|
+
### Usage
|
|
825
|
+
|
|
826
|
+
#### Skills
|
|
827
|
+
|
|
828
|
+
| Skill | What it does |
|
|
829
|
+
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
830
|
+
| [`work`](skills/work/SKILL.md) | Guides an agent through the whole work lifecycle: triaging the inbox, writing the request, spec and plan, implementing, verifying, completing, splitting large items, and coordinating epics. |
|
|
831
|
+
| [`post-mortem`](skills/post-mortem/SKILL.md) | Once a problem has surfaced (rejected work, a false claim in a spec, something shipped that should not have), finds which lifecycle stage could first have caught it. |
|
|
832
|
+
| [`work-create`](skills/work-create/SKILL.md) | Turns an idea for a piece of work into a work item, or adds it to the item or inbox entry that already covers it, after checking what is already tracked. |
|
|
833
|
+
|
|
834
|
+
Most day-to-day work starts from one of the command skills (planning an item,
|
|
835
|
+
driving it to completion, verifying it, processing the inbox) described in
|
|
836
|
+
[Skills and Agents](#skills-and-agents).
|
|
837
|
+
|
|
838
|
+
#### CLI
|
|
839
|
+
|
|
840
|
+
**Board and items**
|
|
841
|
+
|
|
842
|
+
| Command | What it does |
|
|
843
|
+
| --------------- | -------------------------------------------------------------- |
|
|
844
|
+
| `tcw work new` | creates a backlog item and prints its slug |
|
|
845
|
+
| `tcw work list` | shows the board; completed and discarded items only when asked |
|
|
846
|
+
| `tcw work show` | prints an item's status, fields and documents |
|
|
847
|
+
| `tcw work path` | prints the work store's folder, or an item's folder |
|
|
848
|
+
| `tcw work edit` | changes an item's title, estimates, tags, blockers or type |
|
|
849
|
+
| `tcw work tags` | lists, adds or removes the project's registered tags |
|
|
850
|
+
|
|
851
|
+
**Transitions**
|
|
852
|
+
|
|
853
|
+
| Command | What it does |
|
|
854
|
+
| ------------------- | --------------------------------------------------------------------------------- |
|
|
855
|
+
| `tcw work start` | backlog → active |
|
|
856
|
+
| `tcw work submit` | active → review: implemented, waiting for acceptance |
|
|
857
|
+
| `tcw work rework` | review → active: verification rejected the work |
|
|
858
|
+
| `tcw work complete` | closes an item: `--resolution done` → completed, any other resolution → discarded |
|
|
859
|
+
| `tcw work drop` | deletes a backlog item outright |
|
|
860
|
+
| `tcw work delete` | finishes removing a resolved item the project does not keep |
|
|
861
|
+
|
|
862
|
+
**Lifecycle stages**
|
|
863
|
+
|
|
864
|
+
| Command | What it does |
|
|
865
|
+
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
866
|
+
| `tcw work lifecycle` | prints every stage and transition, with what this project attaches to each |
|
|
867
|
+
| `tcw work stage` | `stage gate` checks a stage may run; `stage prompt` prints its instructions; `stage validate` checks the arguments given to the `work-stage` skill |
|
|
868
|
+
| `tcw work procedure` | `procedure prompt` prints one of TCW's procedures, such as `unattended-work` or `search`, with this project's own text for it |
|
|
869
|
+
| `tcw work scaffold` | writes a draft of a stage's document from its template |
|
|
870
|
+
| `tcw work docs` | prints the project's documentation entries: which documents a change must keep up to date |
|
|
871
|
+
|
|
872
|
+
**Inbox, and work across projects**
|
|
873
|
+
|
|
874
|
+
| Command | What it does |
|
|
875
|
+
| -------------------- | ----------------------------------------------------------------- |
|
|
876
|
+
| `tcw work inbox` | `inbox list`, `inbox show` and `inbox accept` raw requests, and Jira tickets awaiting triage |
|
|
877
|
+
| `tcw work nodes` | lists this project's parent and child projects |
|
|
878
|
+
| `tcw work delegate` | writes a request into a child project's inbox |
|
|
879
|
+
| `tcw work escalate` | writes a request into the parent project's inbox |
|
|
880
|
+
| `tcw work reconcile` | reads child projects' items and writes an epic's rolled-up status |
|
|
881
|
+
|
|
882
|
+
**Jira and housekeeping**
|
|
883
|
+
|
|
884
|
+
| Command | What it does |
|
|
885
|
+
| -------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
886
|
+
| `tcw work tracker` | `list`, `show`, `import`, `claim`, `release`, `link`, `unlink` and `sync` against Jira; see [Jira integration](#jira-integration) |
|
|
887
|
+
| `tcw work init` | creates the work store's folders (the same as `tcw init work`) |
|
|
888
|
+
| `tcw work tombstone` | records items resolved before the store kept a record of them, so their slugs are never reused |
|
|
889
|
+
|
|
890
|
+
```sh
|
|
891
|
+
tcw work new "Export invoices as PDF" # → 2026-09-15-export-invoices-as-pdf
|
|
892
|
+
tcw work start 2026-09-15-export-invoices-as-pdf
|
|
893
|
+
tcw work list
|
|
894
|
+
tcw work complete 2026-09-15-export-invoices-as-pdf --resolution done --confirm
|
|
895
|
+
```
|
|
896
|
+
|
|
897
|
+
Every command has `--help`, and the full reference is
|
|
898
|
+
[The Work component](docs/guide/work.md).
|
|
899
|
+
|
|
900
|
+
## Skills and Agents
|
|
901
|
+
|
|
902
|
+
The CLI enforces the rules: which moves are legal, which references must
|
|
903
|
+
resolve, what has to be true before an item completes. What a command cannot
|
|
904
|
+
decide (what a request really asks for, whether a spec is good enough, whether
|
|
905
|
+
the work is finished) is judgment, and the plugin's skills guide an agent through
|
|
906
|
+
it. Skills name `tcw` commands and never reimplement them. Every entry point is a
|
|
907
|
+
skill, so they work the same way under Claude Code and Codex.
|
|
908
|
+
|
|
909
|
+
The skills for a single axis are listed in that axis's section above. These cut
|
|
910
|
+
across the axes.
|
|
911
|
+
|
|
912
|
+
**Setting up and configuring**
|
|
913
|
+
|
|
914
|
+
| Skill | What it does |
|
|
915
|
+
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
916
|
+
| [`setup`](skills/setup/SKILL.md) | Gets TCW working: installs or repairs the CLI, starts using TCW in a repository, sets up a project on a new machine, and drafts a first taxonomy or capabilities list from existing code. |
|
|
917
|
+
| [`configure`](skills/configure/SKILL.md) | Changes a working project's configuration: what runs at each stage or transition, the Definition of Done, documentation entries, Jira, where stores live, connected and inherited projects. |
|
|
918
|
+
| [`documentation-sync`](skills/documentation-sync/SKILL.md) | Decides which documents a finished change must update (README, changelogs, release notes, guides, skills), and runs the version cut when you ask for one. |
|
|
919
|
+
| [`work-stage`](skills/work-stage/SKILL.md) | Reads one lifecycle stage in a single step: the stage's own instructions together with whatever this project adds to them. |
|
|
920
|
+
|
|
921
|
+
**Command skills: the everyday workflows**
|
|
922
|
+
|
|
923
|
+
| Skill | What it does |
|
|
924
|
+
| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
|
925
|
+
| [`commands-process-inbox`](skills/commands-process-inbox/SKILL.md) | Turns raw inbox entries into work items and writes each one's request. |
|
|
926
|
+
| [`commands-plan-work`](skills/commands-plan-work/SKILL.md) | Takes an item, or a request made in chat, through the request, spec and plan stages, and stops before any code. |
|
|
927
|
+
| [`commands-drive-work-to-completion`](skills/commands-drive-work-to-completion/SKILL.md) | Takes an item from wherever it is through implementation, and stops for your verification before completing it. |
|
|
928
|
+
| [`commands-verify-work`](skills/commands-verify-work/SKILL.md) | Checks finished work against its spec with you, and records whether it was accepted or needs rework. |
|
|
929
|
+
| [`commands-pause-work`](skills/commands-pause-work/SKILL.md) | Stops the work in hand, writes down what resuming needs in the item, and waits for you to say carry on. |
|
|
930
|
+
|
|
931
|
+
**Extras: optional, built for one way of working**
|
|
932
|
+
|
|
933
|
+
| Skill | What it does |
|
|
934
|
+
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
|
935
|
+
| [`extras-autonomous-work`](skills/extras-autonomous-work/SKILL.md) | Drives work items to completion unattended, asking read-only advisors wherever the lifecycle would ask you — by default Codex and an Opus subagent, replaceable by your project. |
|
|
936
|
+
| [`extras-triage-issues`](skills/extras-triage-issues/SKILL.md) | Works through **your** project's GitHub issues and turns the ones worth doing into work items. |
|
|
937
|
+
| [`extras-report`](skills/extras-report/SKILL.md) | Files a bug report or suggestion about TCW itself on [this project's issues](https://github.com/brocef/TCW/issues). |
|
|
938
|
+
|
|
939
|
+
**Agents.** Three read-only agents ship with the plugin. None of them edits a
|
|
940
|
+
file or moves an item; each reports back to the session that started it.
|
|
941
|
+
|
|
942
|
+
| Agent | What it does |
|
|
943
|
+
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
944
|
+
| `verifier` | For the `verify` stage: reads the change against the item's spec, runs checks, and reports whether each acceptance criterion is met. |
|
|
945
|
+
| `backlog-auditor` | Checks one backlog item against your project's backlog-audit procedure. By default: already done, out of date, in the wrong project, not actionable, or blocked by something already resolved. |
|
|
946
|
+
| `post-mortem` | Reads an item's documents and commit history backwards to find which stage could first have caught a problem. |
|
|
947
|
+
|
|
948
|
+
## TCW Local Web App
|
|
949
|
+
|
|
950
|
+
`tcw serve` starts a local web app for browsing and editing all three axes, as an
|
|
951
|
+
alternative to the command line.
|
|
952
|
+
|
|
953
|
+
```sh
|
|
954
|
+
tcw serve # http://127.0.0.1:8765/, and opens a browser
|
|
955
|
+
tcw serve --no-open # start without opening a browser
|
|
956
|
+
tcw serve --port 9000 # use a different port
|
|
957
|
+
```
|
|
958
|
+
|
|
959
|
+
- **Requirements.** Node.js 22.12 or newer. The web app's files come prebuilt
|
|
960
|
+
inside the Python package, so it works offline and needs no build step.
|
|
961
|
+
- **What you see.** Tabs for the taxonomy tree, the capabilities list and the work
|
|
962
|
+
board, with filters, sorting and a text search. The address bar follows the view
|
|
963
|
+
(`/taxonomy`, `/work/<slug>`, …), so any page can be bookmarked or shared, and
|
|
964
|
+
any `tcw://` reference in a document is a link to its target.
|
|
965
|
+
- **What you can change.** Create and edit taxonomy entries, capabilities and work
|
|
966
|
+
items, including an item's request, spec, plan and other documents, in a
|
|
967
|
+
Markdown editor with a live preview. Saving runs the same validation rules as
|
|
968
|
+
the CLI and shows any problems.
|
|
969
|
+
- **Lifecycle actions.** The app can `start`, `complete` and `drop` an item;
|
|
970
|
+
`complete` also covers discarding. For `submit` and `rework`, use the CLI.
|
|
971
|
+
- **It runs no lifecycle hooks.** Checks a project attaches to a transition run
|
|
972
|
+
from the CLI only, so a move made in the app skips them. Moves made in the app
|
|
973
|
+
are also not sent to Jira.
|
|
974
|
+
- **Several projects.** When the project has child projects, their boards are
|
|
975
|
+
shown alongside its own, with items addressed as `<project-id>/<slug>`.
|
|
976
|
+
- **Local only.** The server listens only on `127.0.0.1`. Requests that change
|
|
977
|
+
anything must name a local address (`127.0.0.1`, `localhost` or `::1`) and send
|
|
978
|
+
JSON, which blocks other websites
|
|
979
|
+
from making changes through your browser, and two people editing the same object
|
|
980
|
+
cannot silently overwrite each other.
|
|
981
|
+
- **If it fails to start**, check `node --version` is at least `v22.12.0`, and
|
|
982
|
+
try `--port` with a free port.
|
|
983
|
+
|
|
984
|
+
Everything else about the app is in
|
|
985
|
+
[The local web viewer](docs/guide/web-viewer.md).
|
|
986
|
+
|
|
987
|
+
## Documentation
|
|
988
|
+
|
|
989
|
+
| Document | Covers |
|
|
990
|
+
| -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
991
|
+
| [Configuration](docs/guide/configuration.md) | `tcw-config.yaml`: what runs at each stage and transition, prompts, document templates, and documentation entries |
|
|
992
|
+
| [The Work component](docs/guide/work.md) | The lifecycle, every `tcw work` command, tags, the Definition of Done, splitting items, and epics across repositories |
|
|
993
|
+
| [Working from Jira](docs/guide/jira.md) | Connecting a Jira Cloud site: configuration, taking and linking tickets, tickets following their items, and strict mode |
|
|
994
|
+
| [Taxonomy and Capabilities](docs/guide/taxonomy-and-capabilities.md) | Declaring vocabulary, features and capabilities, and inheriting both from other projects |
|
|
995
|
+
| [Working across repositories](docs/guide/multi-repo.md) | Connecting projects, keeping a store in another repository, and fetching what a checkout does not have |
|
|
996
|
+
| [The local web viewer](docs/guide/web-viewer.md) | Everything about `tcw serve` |
|
|
997
|
+
| [Linking and validation](docs/guide/linking-and-validation.md) | `tcw://` references between objects, and `tcw validate` as a CI check |
|
|
998
|
+
| [The abstraction rules](docs/lifecycle/abstraction.md) | Why every operation must work for a store that is not a filesystem, in full |
|
|
999
|
+
| [Release notes](docs/release-notes/) | What changed for users in each version |
|
|
1000
|
+
| Migration guides | Upgrading across a breaking release: [0.10 → 0.11](docs/migration-guide-0.10.X-to-0.11.0.md), [0.12 → 0.13](docs/migration-guide-0.12.X-to-0.13.0.md), [0.14 → 0.15](docs/migration-guide-0.14.X-to-0.15.0.md), [0.15 → 0.16](docs/migration-guide-0.15.X-to-0.16.0.md), [0.21 → 1.0](docs/migration-guide-0.21.X-to-1.0.0.md), [1.x → 2.0](docs/migration-guide-1.X-to-2.0.0.md) |
|
|
1001
|
+
| [Inbox request template](docs/work-inbox-template.md) | A starting shape for a raw request dropped into a work inbox |
|
|
1002
|
+
|
|
1003
|
+
Every command group also has `--help`, and a `check` that validates its tree.
|
|
1004
|
+
|
|
1005
|
+
## Development
|
|
1006
|
+
|
|
1007
|
+
This section is for working on TCW itself.
|
|
1008
|
+
|
|
1009
|
+
### Setting up
|
|
1010
|
+
|
|
1011
|
+
```sh
|
|
1012
|
+
git clone https://github.com/brocef/TCW.git
|
|
1013
|
+
cd TCW
|
|
1014
|
+
pip install -e '.[dev]' # or: scripts/remote_session_setup.sh --force
|
|
1015
|
+
```
|
|
1016
|
+
|
|
1017
|
+
`scripts/remote_session_setup.sh` installs this checkout with its development
|
|
1018
|
+
dependencies and installs the `tcw` plugin from the checkout. In a Claude Code
|
|
1019
|
+
remote session it runs by itself: `.claude/settings.json` wires it to
|
|
1020
|
+
`SessionStart`, and also enables the `tcw` plugin for this repository. It is safe
|
|
1021
|
+
to run repeatedly and prints only when something failed. It is contributor
|
|
1022
|
+
tooling, not the install path for users (that is `scripts/session_bootstrap.sh`,
|
|
1023
|
+
which installs the released `tcw-cli`).
|
|
1024
|
+
|
|
1025
|
+
`tcw work start --worktree` puts an item's edits in a separate git worktree, but
|
|
1026
|
+
the editable install still runs the main checkout's code. How to point it at the
|
|
1027
|
+
worktree, and back again, is in
|
|
1028
|
+
[`AGENTS.md`](AGENTS.md#working-in-a---worktree-branch).
|
|
1029
|
+
|
|
1030
|
+
### Running the tests
|
|
1031
|
+
|
|
1032
|
+
```sh
|
|
1033
|
+
pytest # the Python suite; what CI runs (.github/workflows/test.yml)
|
|
1034
|
+
pnpm typecheck # formatting check, then TypeScript
|
|
1035
|
+
pnpm lint # ESLint over the web app
|
|
1036
|
+
pnpm test # web app unit tests
|
|
1037
|
+
pnpm test:e2e # Playwright end-to-end tests of the web app
|
|
1038
|
+
pnpm build # rebuild the committed web assets
|
|
1039
|
+
pnpm prettify # format source and documentation
|
|
1040
|
+
pnpm prettify:check # check formatting without changing files
|
|
1041
|
+
```
|
|
1042
|
+
|
|
1043
|
+
The `pnpm` commands need Node.js 22.12 or newer and `pnpm install` first. Python
|
|
1044
|
+
tests build their own throwaway git repositories and never read this
|
|
1045
|
+
repository's board.
|
|
1046
|
+
|
|
1047
|
+
### How work is tracked here
|
|
1048
|
+
|
|
1049
|
+
TCW tracks its own development with `tcw work`: every change is a work item under
|
|
1050
|
+
`docs/work/`, and `tcw work list` shows what is in progress. The working rules for
|
|
1051
|
+
contributors, human or agent, are in [`AGENTS.md`](AGENTS.md). This repository
|
|
1052
|
+
attaches its own rules to lifecycle stages:
|
|
1053
|
+
[`docs/lifecycle/abstraction.md`](docs/lifecycle/abstraction.md) at `spec` and
|
|
1054
|
+
`plan`, and [`docs/lifecycle/implementation.md`](docs/lifecycle/implementation.md)
|
|
1055
|
+
and [`docs/lifecycle/harness.md`](docs/lifecycle/harness.md) at `implement`.
|
|
1056
|
+
|
|
1057
|
+
Older design history lives in [`docs/plan/`](docs/plan/) (the original designs
|
|
1058
|
+
for each component) and [`docs/superpowers/`](docs/superpowers/); the developer
|
|
1059
|
+
changelog for each version is in [`docs/changelogs/`](docs/changelogs/).
|
|
1060
|
+
|
|
1061
|
+
### Measuring the skill layer
|
|
1062
|
+
|
|
1063
|
+
[`evals/`](evals/) holds a harness that measures whether this project's lifecycle
|
|
1064
|
+
instructions actually reach an agent, and what the plugin's skills add. The test
|
|
1065
|
+
suite cannot answer that: it can prove a skill file says the right words, but not
|
|
1066
|
+
that an agent read them. Running it starts real agent sessions and costs money;
|
|
1067
|
+
`python -m evals.run_evals --axis a --dry-run` shows what it would run.
|
|
1068
|
+
|
|
1069
|
+
### Releasing
|
|
1070
|
+
|
|
1071
|
+
`python scripts/cut_version.py <patch|minor|major|X.Y.Z>` bumps the version in all
|
|
1072
|
+
five files that carry it, turns the `upcoming.md` changelog and release notes into
|
|
1073
|
+
that version's files, commits and tags. Pushing the tag publishes the release to
|
|
1074
|
+
PyPI. Details, including the one-time PyPI setup, are in
|
|
1075
|
+
[`docs/releasing.md`](docs/releasing.md).
|
|
1076
|
+
|
|
1077
|
+
### Reporting problems
|
|
1078
|
+
|
|
1079
|
+
File bugs and suggestions on
|
|
1080
|
+
[GitHub issues](https://github.com/brocef/TCW/issues). With the plugin installed,
|
|
1081
|
+
the `extras-report` skill gives you a ready-to-fill template.
|
|
1082
|
+
|
|
1083
|
+
### License
|
|
1084
|
+
|
|
1085
|
+
Apache License 2.0; see [`LICENSE`](LICENSE).
|
|
1086
|
+
|
|
1087
|
+
## Further Reading
|
|
1088
|
+
|
|
1089
|
+
- [`AGENTS.md`](AGENTS.md): the working rules for contributing. Read it first.
|
|
1090
|
+
- [`docs/lifecycle/abstraction.md`](docs/lifecycle/abstraction.md): the rule that
|
|
1091
|
+
keeps TCW's model independent of the filesystem, in full.
|
|
1092
|
+
- [`docs/plan/`](docs/plan/): the original design documents for each component.
|
|
1093
|
+
- `tcw work list`: what is being changed in this repository right now.
|