sphica 0.0.0 → 0.1.0

package/.claude-plugin/plugin.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://anthropic.com/claude-code/plugin.schema.json",
+  "name": "sphica",
+  "version": "0.1.0",
+  "description": "Records conversations automatically and recalls past decisions, rejected options, constraints, and what was said.",
+  "author": {
+    "name": "iroha924",
+    "email": "shunichi@hir4ta.com"
+  },
+  "homepage": "https://github.com/iroha924/sphica",
+  "repository": "https://github.com/iroha924/sphica",
+  "keywords": [
+    "knowledge",
+    "rag",
+    "conversations",
+    "decisions",
+    "sqlite"
+  ],
+  "mcpServers": "./mcp/claude.json"
+}

package/.codex-plugin/plugin.json

@@ -0,0 +1,14 @@
+{
+  "name": "sphica",
+  "version": "0.1.0",
+  "description": "Records conversations automatically and recalls past decisions, rejected options, constraints, and what was said.",
+  "author": {
+    "name": "iroha924",
+    "email": "shunichi@hir4ta.com"
+  },
+  "homepage": "https://github.com/iroha924/sphica",
+  "repository": "https://github.com/iroha924/sphica",
+  "skills": "./skills/",
+  "hooks": "./hooks/codex.json",
+  "mcpServers": "./mcp/codex.json"
+}

package/README.md

@@ -1,5 +1,220 @@
 # Sphica
 
-Records Claude Code and Codex sessions on your machine and recalls past decisions, rejected options, constraints, and what was said.
+[![License](https://img.shields.io/github/license/iroha924/sphica)](https://github.com/iroha924/sphica/blob/main/LICENSE)
+[![CI](https://github.com/iroha924/sphica/actions/workflows/check.yml/badge.svg)](https://github.com/iroha924/sphica/actions/workflows/check.yml)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/iroha924/sphica/badge)](https://scorecard.dev/viewer/?uri=github.com/iroha924/sphica)
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/14787/badge)](https://www.bestpractices.dev/projects/14787)
+[![SLSA Build L2](https://img.shields.io/badge/SLSA-Build%20L2-green)](https://www.npmjs.com/package/sphica#provenance)
+[![Dependabot: GitHub Actions](https://img.shields.io/badge/Dependabot-GitHub%20Actions-025E8C?logo=dependabot)](https://github.com/iroha924/sphica/blob/main/.github/dependabot.yml)
 
-This version is a placeholder. The first release is coming soon.
+English | [日本語](https://github.com/iroha924/sphica/blob/main/README.ja.md)
+
+**Local memory of past decisions for Claude Code and Codex.**
+Sphica records your coding sessions and the decisions made in them.
+You or your agent can then look up what was decided, what was rejected, and why, before making the same call again.
+The database is a single SQLite file on your machine.
+
+## Features
+
+- **Look things up while you work.** The MCP tools `recall` and `read` let Claude Code and Codex search past decisions, rejected options, constraints, dead ends, and what you or others said in earlier sessions.
+- **Warnings before an edit (Claude Code).** Before the agent edits a file, a hook shows it the constraints recorded for that exact file and any technical debt that was deliberately left there.
+- **Automatic session recording.** Sphica keeps your prompts, the agent's final reply for each turn, and the paths of files changed by the agent's edit tools.
+- **Decision records on request.** `/sphica:trace` saves the decisions, rejected options, constraints, and dead ends of a session, plus where the work stands.
+- **Multi-perspective review.** `/sphica:review` runs a separate reviewer for each focus: correctness, security, and written conventions by default, plus redundancy and past decisions with `full`. When Codex is installed, it offers to repeat the review with Codex.
+- **Terminal dashboard.** `sphica dashboard` browses sessions, work in progress, and search results. It is read-only.
+- **GitHub and docs import.** `sphica harvest` imports pull requests, issues, and the repository's Markdown files.
+
+The agent is told to treat records as history, not instructions, and to trust the code when a record and the current code disagree.
+
+## Requirements
+
+- Node.js 24.15 or later
+- Claude Code or Codex, or both
+- `git`, to identify the repositories you register
+- For `sphica harvest` only: the GitHub CLI (`gh`), signed in with `gh auth login`
+
+## Install
+
+The plugin ships the MCP server, hooks, and skills. The `sphica` CLI comes from npm and is installed separately. You need both.
+
+**1. Install the CLI**
+
+```bash
+npm i -g sphica
+```
+
+**2. Add the plugin**
+
+Claude Code:
+
+```bash
+claude plugin marketplace add iroha924/sphica
+claude plugin install sphica@sphica
+```
+
+Codex:
+
+```bash
+codex plugin marketplace add iroha924/sphica --ref main
+codex plugin add sphica@sphica
+```
+
+In Codex, open `/hooks` and mark Sphica's hooks as trusted. Nothing is recorded until you do. If a plugin update changes the hooks, trust them again.
+
+**3. Create the database**
+
+```bash
+sphica init
+```
+
+This creates `~/.sphica/sphica.db`. Running it again leaves an existing database untouched.
+
+**4. Check the setup**
+
+```bash
+sphica doctor
+```
+
+`doctor` checks Node.js, the CLI and plugin versions, the database, and the recording queue. Start here whenever something looks wrong.
+
+## Quick start
+
+Sphica writes sessions to the database only for repositories you register. A registered repository is called a project.
+
+```bash
+cd ~/Projects/your-repo
+sphica project add
+```
+
+If the repository has no `origin` remote, give it a name: `sphica project add --name <name>`.
+
+Then work as usual in Claude Code or Codex. To bring back earlier decisions, ask the agent:
+
+- "Did we already decide how to handle retries here?"
+- "Why did we choose this approach?"
+- "What did I say about the migration last week?"
+- "Let's continue where we left off."
+
+The agent searches with `recall` and opens full records with `read`. At the end of a session with decisions worth keeping, run `/sphica:trace`.
+
+To import GitHub history and Markdown docs:
+
+```bash
+sphica harvest              # every project Sphica can find on this machine
+sphica harvest --cwd .      # only the current repository
+```
+
+Without `--cwd`, Sphica looks for projects directly under `~/Projects` and for projects registered with `--name`. Use `--cwd` for a repository somewhere else.
+Docs are read from the default branch of `origin`, or from the local `HEAD` when there is no `origin`.
+
+To browse everything in the terminal:
+
+```bash
+sphica dashboard   # Tab switches screens, / searches, p changes project, q quits
+```
+
+## What gets recorded and where it goes
+
+- **Where.** The database is `~/.sphica/sphica.db`. Records wait in a local queue, `~/.sphica/spool`, until they are written to it. Each machine has its own database, and records are not shared between machines.
+- **What.** Your prompts, the agent's final reply for each turn, and the paths of edited files. Background-task notifications and messages from other agents are skipped when Sphica recognizes their format.
+- **Unregistered repositories.** Sessions in a repository you have not registered stay in the queue. They are written to the database after you register the repository. Held records are dropped after 30 days, and when more than 1,000 are waiting the oldest go first.
+- **Secrets.** Only secrets with a recognizable shape are masked:
+  - keys with known prefixes
+  - `KEY=…` and `"password": …` assignments
+  - credentials in URLs
+  - authorization headers
+  - `mysql -p`
+
+  **Anything else is stored as typed, so do not paste secrets into a session.**
+- **Network.** Sphica has no account, no hosted service, and no telemetry, and makes no network connections itself. Two commands call other tools that may: `sphica harvest` runs `git fetch` and `gh api` with your credentials, and `sphica doctor` runs `npm` and `claude` to check installed versions.
+- **Text written by others.** Pull request and issue text imported by `harvest` may come from anyone. It is passed to the agent as data, and the MCP server cannot write to the database.
+
+To delete a project's data, run `sphica project forget <name>`, where `<name>` is shown by `sphica project list`. Without `--yes`, it only shows how many records would be deleted. It deletes records in the database only. Records still waiting in `~/.sphica/spool` stay there and can be imported again if you register the repository again.
+
+Before you stop using a machine, run `sphica capture flush` until `sphica doctor` shows no records waiting to be sent. Each run writes up to 500 records. Records from unregistered repositories are not written, so register those repositories first if you want to keep them.
+
+## Updating
+
+The CLI and the plugin are updated separately.
+
+```bash
+npm i -g sphica@latest
+```
+
+Claude Code:
+
+```bash
+claude plugin marketplace update sphica
+claude plugin update sphica@sphica
+```
+
+Codex:
+
+```bash
+codex plugin marketplace upgrade sphica
+codex plugin add sphica@sphica
+```
+
+Restart open sessions afterwards. When a release changes the database schema, the CLI asks you to run `sphica db migrate`. Back up `~/.sphica/sphica.db` before you run it.
+
+## Uninstalling
+
+```bash
+npm uninstall -g sphica
+```
+
+Claude Code:
+
+```bash
+claude plugin uninstall sphica@sphica
+```
+
+Codex:
+
+```bash
+codex plugin remove sphica@sphica
+```
+
+Your records stay in `~/.sphica/` until you delete that directory yourself.
+
+## Troubleshooting
+
+Run `sphica doctor` first. It shows which part is out of date or not working. Common cases:
+
+- **`sphica: command not found`.** The plugin does not put the CLI on your PATH. Run `npm i -g sphica`.
+- **Nothing is recorded.** Check that the repository is registered with `sphica project list`. In Codex, also check that the hooks are trusted in `/hooks`.
+- **The MCP server reports an older version.** Restart the session, or run `/reload-plugins` in Claude Code.
+- **A search finds nothing.** Search matches words. Try other words, English and Japanese, or shorter terms. An empty result doesn't mean nothing was recorded.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `sphica init` | Create the database |
+| `sphica doctor` | Check versions, the database, and recording |
+| `sphica project add` | Register the current repository as a project |
+| `sphica harvest` | Import GitHub pull requests, issues, and Markdown docs |
+| `sphica search <words>` | Search from the terminal |
+| `sphica dashboard` | Browse sessions, work, and search results |
+
+Run `sphica --help` for the full list and `sphica <command> --help` for each command's options.
+
+## Security
+
+Report vulnerabilities privately as described in [SECURITY.md](https://github.com/iroha924/sphica/blob/main/SECURITY.md).
+
+Since 0.37.1, each release is built by GitHub Actions from a tag on the head of a pull request whose CI has passed, and staged on npm.
+The maintainer checks its SHA-512 checksum and provenance, then approves publication with two-factor authentication.
+For these versions, the [npm page](https://www.npmjs.com/package/sphica#provenance) links to the workflow and the commit each one was built from.
+
+Dependabot opens pull requests to update the GitHub Actions used in CI. It does not cover the npm dependencies bundled into the package, because Dependabot cannot read the Bun lockfile format (v2) this repository uses.
+
+## Contributing
+
+Issues are welcome. Pull requests from outside contributors are closed without review, because the review tools here run with maintainer credentials and cannot safely check out code written by others.
+
+Changes that add or change behavior include automated tests in the same pull request. CI runs them with `bun run verify` on every pull request.
+
+## License
+
+[MIT](https://github.com/iroha924/sphica/blob/main/LICENSE). The published package bundles its dependencies. Their licenses are listed in `THIRD_PARTY_NOTICES.md` inside the package.