{
  "markdown": "# ClineFlow\n\n> **Infinite AI Memory across chats, agents, and teams.**\n\nClineFlow gives coding agents durable, Git-native project context. Decisions, goals, verification, and handoffs live beside the code in an open knowledge bundle—not inside one temporary chat or proprietary memory service.\n\n[![Test ClineFlow](https://github.com/hassanvfx/clineflow/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/hassanvfx/clineflow/actions/workflows/test.yml?query=branch%3Amain)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.22288633.svg)](https://doi.org/10.5281/zenodo.22288633)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n[![OKF v0.2](https://img.shields.io/badge/OKF-v0.2-1e9fff)](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)\n[![Agent Agnostic](https://img.shields.io/badge/agents-Cline%20%7C%20Codex%20%7C%20Claude%20Code%20%7C%20Cursor%20%7C%20Copilot%20%7C%20Windsurf-1e9fff)](#works-with-your-agent)\n\n![ClineFlow — Persistent Context, Open Knowledge](assets/clineflow-okf-cover.png)\n\n## Install ClineFlow\n\nRun this command from your project folder in your favorite AI agent:\n\n```text\nPlease install ClineFlow by following the instructions provided at https://github.com/hassanvfx/clineflow\n```\n\nThe agent reads the current installation instructions, shows the prerequisite plan, installs ClineFlow into the project, and verifies the result.\n\nPrefer the terminal?\n\n```bash\n# macOS and Linux\ncurl -fsSL https://raw.githubusercontent.com/hassanvfx/clineflow/main/template/.clineflow/bin/install | bash\n```\n\n```powershell\n# Windows PowerShell\nirm https://raw.githubusercontent.com/hassanvfx/clineflow/main/template/.clineflow/bin/bootstrap.ps1 | iex\n```\n\nThe installer preserves existing project instructions and knowledge. When Git is available, it initializes a repository if needed—but never creates a commit, configures identity, adds a remote, or chooses a branch policy.\n\n[Installation, lifecycle options, and troubleshooting →](docs/installation-and-lifecycle.md)\n\n## The whole workflow is three sentences\n\n### 1. Install once\n\nPaste the installation prompt. ClineFlow adds a small hidden runtime, an open knowledge bundle, and shared instructions for supported coding agents.\n\n### 2. Describe the outcome\n\nAsk for a feature, fix, investigation, or refactor as usual. For substantial work, the agent recovers current project context and creates a tenant-scoped Engineering Journal stream. A stable opaque tenant ID comes from explicit Git author identity when available, then a local machine fallback; raw identity values never enter the repository.\n\n### 3. Say “please commit”\n\n```text\nPlease commit.\n```\n\nThe agent updates the task journal, publishes an immutable additive update record, rebuilds the five local ledger views, validates the complete change set, and commits code plus context together. Concurrent tenants write separate journals and update records, so their work does not collide in shared ledger files.\n\nThe next chat begins from what the project already knows.\n\n[See how the self-documenting loop works →](docs/how-clineflow-works.md)\n\n[Read the complete workflow manual →](docs/workflow-manual.md)\n\n## Quick tutorial\n\n[![Watch the ClineFlow 30-minute tutorial](assets/clineflow-tutorial-thumbnail.jpg)](https://vimeo.com/1220645170?fl=pl&fe=cm)\n\n**[Watch the 30-minute ClineFlow masterclass →](https://vimeo.com/1220645170?fl=pl&fe=cm)**\n\nIt walks through grounding a task, defining proof, building with an agent, preserving the verified state, and carrying that context into the next session.\n\n## What gets installed\n\n```text\nyour-project/\n├── .clineflow/                         # Hidden, ClineFlow-managed runtime\n│   ├── bin/                            # Install, update, remove, doctor, and validators\n│   ├── VERSION                         # Installed release\n│   ├── state                           # Release and migration state\n│   ├── release-manifest                # Managed payload checksums and ownership\n│   ├── PROCEDURES.md                   # Operating procedures\n│   ├── WORKING_WITH_CLINE.md           # Cline guide\n│   └── WORKING_WITH_CODEX.md           # Codex guide\n├── knowledge/                          # Your Git-native OKF knowledge base\n│   ├── index.md                        # Progressive-disclosure entry point\n│   ├── updates/<topic>/                # Immutable tenant update records\n│   ├── journals/<topic>/               # Tenant journal work streams\n│   ├── clineflow_*.yml                 # Rebuilt local ledger views\n│   └── log.md                          # Rebuilt local knowledge history\n│   └── journals/                       # Detailed Engineering Journals\n├── docs/\n│   └── durable-development-methodology.md\n├── .claude/commands/update-clineflow.md # Deterministic Claude update command\n├── AGENTS.md                           # Codex, Cursor, and compatible agents\n├── CLAUDE.md                           # Claude Code\n├── .clinerules                         # Cline\n├── .github/copilot-instructions.md     # GitHub Copilot\n└── .windsurf/rules/clineflow.md        # Windsurf\n```\n\nExisting agent files are not replaced. ClineFlow adds one marker-delimited block and records whether it owns the whole file or only that block. The hidden `.clineflow/` directory is tooling; `knowledge/` is your project memory.\n\n[Complete installed-file and ownership reference →](docs/installation-and-lifecycle.md#what-the-installer-adds)\n\n## Journals hold the story. Ledgers make it discoverable.\n\nAn Engineering Journal is the durable record for one substantial task: its goal, decisions, work log, verification, open issues, and next steps. It replaces the fragile chat transcript with concise project knowledge.\n\nThe five YAML ledgers are the front door:\n\n| Ledger | The question it answers |\n| --- | --- |\n| `clineflow_goals.yml` | Why are we doing this, and what does success mean? |\n| `clineflow_specification.yml` | What behavior and constraints have we agreed on? |\n| `clineflow_verification.yml` | What proves the work is complete? |\n| `clineflow_last_session.yml` | What is true now, and what should happen next? |\n| `clineflow_timeline.yml` | How did the project reach this state? |\n\nAgents read the ledgers first, then follow links into relevant journals. At commit time, the journal and all five ledgers move forward together with one shared timestamp. ClineFlow validates that synchronization before the commit is created.\n\n[Explore the OKF knowledge structure →](docs/okf-knowledge-workflow.md)\n\n## See the project memory\n\nAsk your agent:\n\n```text\nPlease show me the ClineFlow dashboard.\n```\n\nThe Knowledge Visor stays dormant until explicitly requested. On first use it shows an approval plan for its optional pinned runtime and visual assets, then generates a private, self-contained report from local OKF knowledge and Git history. The report does not edit canonical knowledge or make browser-time network requests.\n\nGenerated reports remain in `knowledge/dashboard/` even if ClineFlow tooling is later removed.\n\n[See the Knowledge Visor's report surfaces, activation, privacy, retention, and export workflow →](docs/knowledge-visor.md)\n\n## Update or remove it in plain English\n\nTo update:\n\n```text\nPlease update ClineFlow.\n```\n\nThat request authorizes the agent to consult this authoritative repository and immediately run the permanent remote updater with `--yes`. **Do not run any existing local updater first**; legacy copies can overwrite themselves. Updates are manifest-verified, preserve user-authored knowledge and instructions, and roll back automatically on failure.\n\n### Old install or prompt not recognized?\n\nRun this rescue command yourself from the project root. It bypasses stale installed instructions and downloads the current transactional updater directly from the authoritative repository:\n\n```bash\ncurl -fsSL https://raw.githubusercontent.com/hassanvfx/clineflow/main/update.sh | bash -s -- --yes\n```\n\nOn Windows PowerShell:\n\n```powershell\n& ([scriptblock]::Create((irm https://raw.githubusercontent.com/hassanvfx/clineflow/main/template/.clineflow/bin/update.ps1))) -Yes\n```\n\nAfter it finishes, verify the result with `cat .clineflow/VERSION` or `Get-Content .clineflow/VERSION`. If the updater cannot safely identify or migrate the installation, it stops before mutation or restores the prior installation instead of forcing an upgrade.\n\nTo remove:\n\n```text\nPlease remove ClineFlow.\n```\n\nThe agent first runs a dry run and explains what will be removed and preserved. It asks for confirmation before applying the removal. The managed `.clineflow/` runtime and managed instruction blocks are removed transactionally; `knowledge/`, generated dashboard reports, user documentation, and unrelated files remain.\n\n```bash\n./.clineflow/bin/uninstall --dry-run\n```\n\n[Update and removal details →](docs/installation-and-lifecycle.md#update-clineflow)\n\n## Works with your agent\n\nClineFlow distributes one agent-neutral workflow through the native project-instruction files used by:\n\n- Cline\n- ChatGPT Codex\n- Claude Code\n- Cursor\n- GitHub Copilot\n- Windsurf\n\nNo Codex plugin, proprietary service, or always-running ClineFlow process is required. The durable contract is Markdown, YAML, links, and Git.\n\n## Go deeper\n\n- [Installation and lifecycle](docs/installation-and-lifecycle.md)\n- [How ClineFlow works](docs/how-clineflow-works.md)\n- [Workflow manual](docs/workflow-manual.md)\n- [OKF knowledge workflow](docs/okf-knowledge-workflow.md)\n- [Knowledge Visor](docs/knowledge-visor.md)\n- [Durable development methodology](docs/durable-development-methodology.md)\n- [Working with ChatGPT Codex](template/.clineflow/WORKING_WITH_CODEX.md)\n- [Working with Cline](template/.clineflow/WORKING_WITH_CLINE.md)\n- [Release and migration process](docs/releasing.md)\n- [Changelog](CHANGELOG.md)\n\n## Learn and contribute\n\n- [ClineFlow website](https://www.clineflow.com/)\n- [Infinite AI Context — free eBook and print edition](https://hassanvfx.github.io/infinite-ai-context/)\n- [Report an issue](https://github.com/hassanvfx/clineflow/issues)\n- [Contribute](https://github.com/hassanvfx/clineflow/pulls)\n\n## License\n\n[MIT](LICENSE)\n",
  "bytes": 10205,
  "sha": "ba1cdcde8a538bd27387c92b73fc1efaf3f37f2099aef10266af0de090c4a894",
  "repo_slug": "hassanvfx/clineflow",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/okf_hassanvfx_clineflow_knowledge_index_md_0eb7b521/readme"
}