@fyso/awareness-framework 0.1.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,112 @@
+# Awareness Framework
+
+Awareness Framework is a working methodology for humans who use multiple AI agents across parallel tasks. It gives agents a shared operational protocol for current focus, task handoff, daily worklogs, and process evaluation without depending on hidden model memory.
+
+This repository contains the framework, templates, and governance rules. It must not contain real awareness boards, daily worklogs, personal memories, customer details, or private task state.
+
+## What This Is
+
+- A methodology for agent-assisted work.
+- A shared vocabulary for awareness, worklog, handoff, and evaluation.
+- A set of templates that can be copied into private local state.
+- An optional helper CLI that maintains and checks private state.
+- A reviewable process for improving the methodology over time.
+
+## What This Is Not
+
+- Not a task manager.
+- Not dependent on a CLI tool.
+- Not a Jira replacement.
+- Not a vector memory product.
+- Not a place to store private operational state.
+
+## Core Artifacts
+
+| Artifact | Versioned here? | Purpose |
+|----------|-----------------|---------|
+| Framework docs | Yes | Canonical methodology and rules |
+| Templates | Yes | Sanitized starting points |
+| Awareness board | No | Mutable private current state |
+| Daily worklog | No | Append-only private record of the day |
+| Personal memory | No | Durable private preferences and patterns |
+| Evaluation notes | No by default | Private observations used to propose framework improvements |
+
+Personality is treated as a private operating profile: continuity, voice, context sensitivity, bounded initiative, and honest repair. It must not become fake emotion, fake identity, or hidden autonomy.
+
+## Recommended Private Layout
+
+```text
+~/.agents/
+  AGENTS.md
+  awareness/
+    current.md
+  worklog/
+    YYYY-MM-DD.md
+  memory/
+    preferences.md
+    patterns.md
+    long-term.md
+    users/
+      <user>.md
+  evaluations/
+    YYYY-MM-DD.md
+  runtime/
+    hooks/
+    schedule/
+  channels/
+    <channel>/
+      awareness/
+      worklog/
+      memory/
+        users/
+```
+
+## Method
+
+1. At session start, the agent loads private awareness state. If the CLI is available, it runs `awareness status` or `awareness check`; otherwise it reads the private awareness board.
+2. When focus changes, the agent updates awareness and appends a task-switch worklog entry.
+3. When concrete progress happens, the agent appends a worklog entry with evidence.
+4. Before handoff, or when parallel work may have changed state, the agent refreshes from disk and leaves a clear current state and next action.
+5. At end of day, the agent prepares a task-grouped summary for human review.
+6. During evaluation, the agent identifies process friction and proposes framework changes through PRs.
+
+## Documentation
+
+- [Install](docs/install.md)
+- [Framework](docs/framework.md)
+- [Lifecycle](docs/lifecycle.md)
+- [Private State](docs/private-state.md)
+- [Evaluation Loop](docs/evaluation-loop.md)
+- [Memory Model](docs/memory.md)
+- [Multi-User Scoping](docs/multi-user-scoping.md)
+- [Hooks and Scheduling](docs/hooks-and-scheduling.md)
+- [CLI](docs/cli.md)
+- [Personality](docs/personality.md)
+- [Adoption Guide](docs/adoption.md)
+- [Governance](docs/governance.md)
+
+## Templates
+
+- [Agent instructions](templates/agent-instructions.md)
+- [CLI wrapper](templates/cli-wrapper.md)
+- [Awareness board](templates/awareness-current.md)
+- [Daily worklog](templates/daily-worklog.md)
+- [End-of-day summary](templates/end-of-day-summary.md)
+- [Evaluation note](templates/evaluation-note.md)
+- [Framework improvement proposal](templates/framework-improvement-proposal.md)
+- [Personality profile](templates/personality.md)
+
+## CLI Quick Start
+
+```bash
+npm install -g @fyso/awareness-framework
+awareness init
+awareness init --wrappers
+awareness status
+awareness refresh
+awareness check
+awareness hook install --tool all --command "$(command -v awareness)"
+awareness schedule install --cadence all --command "$(command -v awareness)"
+```
+
+The CLI only reads and writes private local files. It does not post to Jira, GitHub, or any external system.

package/bin/awareness.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+import { runCli } from '../src/cli.js';
+
+process.exitCode = runCli(process.argv.slice(2), {
+  env: process.env,
+  stdout: process.stdout,
+  stderr: process.stderr,
+});

package/docs/adoption.md

@@ -0,0 +1,99 @@
+# Adoption Guide
+
+This framework can be adopted by any AI coding agent or assistant that can read and write local files.
+
+## Local Setup
+
+Create private files outside this repository:
+
+```text
+~/.agents/
+  AGENTS.md
+  awareness/current.md
+  worklog/YYYY-MM-DD.md
+```
+
+Copy the templates from `templates/` into private state and adapt paths for the operator.
+
+Alternatively, use the helper CLI:
+
+```bash
+npm install -g @fyso/awareness-framework
+awareness init
+awareness init --wrappers
+```
+
+See [Install](install.md) for the full setup flow.
+
+## Agent Instruction Pattern
+
+Use one canonical private instruction file:
+
+```text
+~/.agents/AGENTS.md
+```
+
+Then use small per-agent wrappers that point to it.
+
+This keeps the methodology consistent across agents while allowing each CLI to use its own instruction-file location.
+
+## Wrapper Pattern
+
+Some agents support direct imports from instruction files. Others require explicit text telling the agent to read the canonical file.
+
+Use a regular file for each wrapper. Avoid relying on symlinks unless the target CLI is known to resolve them correctly in the operator's environment.
+
+Direct imports and `@path` expansion should be treated as session-start snapshots. They are useful for bootstrap context, but they do not guarantee that the agent sees changes made by another agent later in the session.
+
+If the CLI is available, wrappers should instruct agents to use:
+
+- `awareness status` or `awareness check` at session start
+- `awareness refresh` before acting on possibly stale state
+- `awareness handoff` before returning control
+
+Example wrapper:
+
+```markdown
+# Local Agent Instructions
+
+Read and follow the canonical private protocol at:
+
+@/Users/example/.agents/AGENTS.md
+
+If your CLI does not expand `@` imports automatically, open that file explicitly before starting work.
+
+If the Awareness CLI is available, run `awareness status` or `awareness check` at session start, `awareness refresh` before acting on possibly stale state, and `awareness handoff` before returning control.
+```
+
+## External Systems
+
+The framework complements external systems.
+
+| System | Role |
+|--------|------|
+| Jira | Planning, accountability, final worklog target |
+| GitHub Issues | Code-related tasks and discussion |
+| Pull requests | Reviewable code and documentation changes |
+| Task managers | Optional project decomposition |
+| Awareness board | Local current operating state |
+| Daily worklog | Local chronological evidence |
+
+Do not duplicate every external field. Store only what helps the next agent session and the end-of-day report.
+
+## End-of-Day Flow
+
+1. Read the daily worklog.
+2. Group entries by task ID.
+3. Attach evidence.
+4. Identify blockers.
+5. Prepare suggested external worklog text.
+6. Ask for human confirmation before posting.
+
+## Migration From Ad Hoc Notes
+
+Start small:
+
+1. Use only `Current Focus`, `Active Tasks`, and the daily worklog.
+2. Add `Blocked Tasks` when parallel work increases.
+3. Add evaluation notes after the process has been used for at least one day.
+4. Promote only repeated improvements into this repository.

package/docs/cli.md

@@ -0,0 +1,300 @@
+# CLI
+
+The Awareness Framework CLI is an optional helper. The framework does not require a tool, but the CLI reduces how much methodology an agent must keep in context.
+
+Instead of asking every agent to remember the full protocol, use commands that check and maintain private files.
+
+## Install
+
+```bash
+npm install -g @fyso/awareness-framework
+```
+
+See [Install](install.md) for first-run setup, wrapper initialization, updates, and custom paths.
+
+For local development:
+
+```bash
+npm install
+npm test
+npm link
+```
+
+## Private State
+
+By default, commands use:
+
+```text
+~/.agents/
+```
+
+Override with:
+
+```bash
+awareness status --home /path/to/private/agents
+```
+
+or:
+
+```bash
+AGENTS_HOME=/path/to/private/agents awareness status
+```
+
+Use channel-scoped state for multi-channel integrations:
+
+```bash
+awareness status --channel support
+```
+
+This resolves to:
+
+```text
+~/.agents/channels/support/
+```
+
+Use `--agent-folder` as a clearer alias when the path is a base folder:
+
+```bash
+awareness status --agent-folder /path/to/agents --channel support
+```
+
+User memory is narrow and separate from the channel context. It lives under `memory/users/` inside the selected channel or base folder.
+
+## Session Bootstrap vs Operational Refresh
+
+Instruction-file imports are a bootstrap mechanism. They can load a snapshot of `current.md` at session start, but they do not guarantee that an agent sees updates made later by another agent.
+
+Use the CLI as the operational refresh and maintenance layer:
+
+- At session start, run `awareness status` or `awareness check` when the CLI is available.
+- If the session may be stale because another agent worked in parallel, run `awareness refresh`.
+- Before handoff, run `awareness handoff` or `awareness check`.
+- When changing state, prefer `awareness focus` and `awareness log` over manual edits.
+
+If the CLI is not available, read `~/.agents/awareness/current.md` directly.
+
+## Commands
+
+### `init`
+
+Creates the private directory structure and starter files if they do not exist.
+
+```bash
+awareness init
+```
+
+Creates:
+
+- `AGENTS.md`
+- `awareness/current.md`
+- `worklog/YYYY-MM-DD.md`
+- `memory/personality.md`
+- `memory/preferences.md`
+- `memory/patterns.md`
+- `memory/long-term.md`
+- `evaluations/`
+- `runtime/`
+
+Create regular wrapper files for Codex, Claude Code, OpenCode, and Pi:
+
+```bash
+awareness init --wrappers
+```
+
+Existing wrappers are preserved. To replace them intentionally:
+
+```bash
+awareness init --wrappers --overwrite-wrappers
+```
+
+Use custom roots for tests or non-standard machines:
+
+```bash
+awareness init --wrappers \
+  --home /path/to/.agents \
+  --user-home /path/to/user-home \
+  --config-home /path/to/config-home
+```
+
+### `status`
+
+Shows the current focus and warnings.
+
+```bash
+awareness status
+```
+
+### `refresh`
+
+Reloads the awareness board from disk and prints the current status. This is an alias for `status` with a name that makes the cross-agent refresh intent explicit.
+
+```bash
+awareness refresh
+```
+
+### `check`
+
+Checks whether private state is maintainable.
+
+```bash
+awareness check
+awareness check --strict
+```
+
+Use `--strict` in automation when warnings should fail the command.
+
+### `focus`
+
+Updates `Current Focus`, upserts the task in `Active Tasks`, and appends a worklog entry.
+
+```bash
+awareness focus \
+  --task PROJECT-123 \
+  --summary "Agent awareness framework" \
+  --repo fyso-dev/awareness-framework \
+  --branch codex/cli-and-personality \
+  --next "Run tests and open a PR"
+```
+
+### `log`
+
+Appends a concrete progress entry to the daily worklog.
+
+```bash
+awareness log \
+  --task PROJECT-123 \
+  --summary "Added CLI helper" \
+  --changes "Implemented init, status, check, focus, log, handoff, evaluate, and personality commands." \
+  --evidence "src/cli.js"
+```
+
+### `handoff`
+
+Prints a handoff snapshot from the awareness board.
+
+```bash
+awareness handoff
+```
+
+### `evaluate`
+
+Builds a private daily evaluation note using simple heuristics.
+
+```bash
+awareness evaluate
+awareness evaluate --print
+awareness evaluate --force
+```
+
+The CLI does not automatically change the framework. Repeated findings should become reviewed framework changes.
+
+### `hook run`
+
+Records a lightweight lifecycle event from an agent CLI hook.
+
+```bash
+awareness hook run --tool codex --event session-start
+awareness hook run --tool claude --event pre-compact --quiet
+awareness hook run --tool opencode --event session.idle
+```
+
+This writes JSON lines under:
+
+```text
+~/.agents/runtime/hooks/YYYY-MM-DD.jsonl
+```
+
+Hook events do not append to the daily worklog. Use `awareness log` for human-relevant progress.
+
+### `hook install`
+
+Installs supported hook integrations.
+
+```bash
+awareness hook install --tool all --command "$(command -v awareness)"
+awareness hook install --tool codex --command "$(command -v awareness)"
+awareness hook install --tool claude --command "$(command -v awareness)"
+awareness hook install --tool opencode --command "$(command -v awareness)"
+```
+
+Generated files:
+
+- `~/.codex/hooks.json`
+- `~/.claude/settings.json`
+- `~/.config/opencode/plugins/awareness-framework.js`
+
+Use an absolute `--command` path when hooks run outside an interactive shell.
+
+For OpenCode, `--overwrite` replaces an existing non-generated plugin file. Use it only when that file is intentionally managed by this framework.
+
+### `schedule run`
+
+Runs periodic maintenance.
+
+```bash
+awareness schedule run --cadence hourly
+awareness schedule run --cadence daily
+```
+
+Hourly runs record warnings under `runtime/schedule/`. Daily runs also create `evaluations/YYYY-MM-DD.md` if it does not exist.
+
+### `schedule install`
+
+Installs macOS LaunchAgents for global periodic execution.
+
+```bash
+awareness schedule install --cadence all --command "$(command -v awareness)"
+awareness schedule install --cadence all --command "$(command -v awareness)" --load
+```
+
+Generated files:
+
+- `~/Library/LaunchAgents/dev.fyso.awareness.hourly.plist`
+- `~/Library/LaunchAgents/dev.fyso.awareness.daily.plist`
+
+See [Hooks and Scheduling](hooks-and-scheduling.md) for tool-specific notes.
+
+### `user show`
+
+Shows narrow memory for a user. If `--channel` is provided, memory is read from that channel's private state.
+
+```bash
+awareness user show --user user-123
+awareness user show --channel support --user user-123
+```
+
+### `user note`
+
+Appends a small evidence-backed fact about a user.
+
+```bash
+awareness user note \
+  --channel support \
+  --user user-123 \
+  --kind question \
+  --text "Asked how worklog automation should be organized" \
+  --evidence "Message link or timestamp"
+```
+
+Supported kinds:
+
+- `nickname`
+- `question`
+- `topic`
+- `preference`
+- `fact`
+- `note`
+
+User notes do not create a full awareness workspace for that user. Channel context remains in `awareness/` and `worklog/`; user memory remains in `memory/users/<user>.md`.
+
+## Personality Commands
+
+Personality is stored privately in `~/.agents/memory/personality.md`.
+
+```bash
+awareness personality show
+awareness personality note --text "User prefers concise Spanish status updates" --evidence "Repeated feedback"
+awareness personality adopt --text "Use direct, pragmatic Spanish for work updates" --evidence "User confirmed preference"
+```
+
+Candidate observations are cheap to record. Accepted traits should come from repeated evidence or explicit user confirmation.