# filecoin-pin - Doramagic AI Context Pack

> Purpose: pre-work context for the user's host AI. This pack does not prove that the project has been installed, run, or validated.

## Project

- canonical_name: `filecoin-project/filecoin-pin`
- capability: Filecoin Pin
- expected_user_outcome: Filecoin Pin

## Operating Boundaries

- Do not claim that the project has been installed, run, called through an API, or used on local files unless separate evidence proves it.
- Project facts must come from repo evidence, Claim Graph, or explicit source references.
- When a capability is not verified, mark it as unverified instead of completing it as fact.
- publish_status: `publishable`
- blocking_gaps: none

---

## Doramagic Context Augmentation

The following sections strengthen the repository context for a host AI. Human Manual data is a reading route, and pitfall notes become operating constraints.

## Human Manual Outline

Usage rule: this is only a reading route and salience signal, not factual authority. Concrete claims must still return to repo evidence or Claim Graph.

Host AI hard rules:
- Do not treat page titles, section order, summaries, or importance values as factual project evidence.
- When explaining the Human Manual outline, state that it is only a reading route or salience signal.
- Capability, installation, compatibility, runtime state, and risk claims must cite repo evidence, source paths, or Claim Graph.

- **Overview and System Architecture**: importance `high`
  - source_paths: README.md, documentation/README.md, documentation/glossary.md, documentation/behind-the-scenes-of-adding-a-file.md, documentation/content-routing-faq.md
- **CLI Command Reference**: importance `high`
  - source_paths: src/cli.ts, src/commands/index.ts, src/commands/add.ts, src/commands/import.ts, src/commands/data-set.ts
- **JavaScript Library and Core Modules**: importance `high`
  - source_paths: src/index.ts, src/index-types.ts, src/index.browser.ts, src/core/index.ts, src/core/browser.ts
- **Integrations, Configuration, and Operations**: importance `high`
  - source_paths: upload-action/README.md, upload-action/FLOW.md, upload-action/action.yml, upload-action/package.json, upload-action/src/run.mjs

## Repo Inspection Evidence

- repo_clone_verified: true
- repo_inspection_verified: true
- repo_commit: `29652e43332533fa8c37684c67796d3b01a0caf4`
- inspected_files: `README.md`, `package.json`, `pnpm-lock.yaml`, `src/add/add.ts`, `src/add/types.ts`, `src/cli.ts`, `src/commands/add.ts`, `src/commands/data-set.ts`, `src/commands/import.ts`, `src/commands/index.ts`, `src/commands/payments.ts`, `src/commands/provider.ts`, `src/commands/remove.ts`, `src/commands/server.ts`, `src/commands/session.ts`, `src/common/cli-errors.ts`, `src/common/constants.ts`, `src/common/devnet-config.browser.ts`, `src/common/devnet-config.ts`, `src/common/get-rpc-url.ts`

Host AI hard rules:
- Without repo_clone_verified=true, do not claim that the source code has been read.
- Without repo_inspection_verified=true, do not write README, docs, or package-file conclusions as facts.
- Without quick_start_verified=true, do not claim that the Quick Start path has run successfully.

## Doramagic Pitfall Constraints

These rules come from Doramagic discovery, validation, or compilation findings. The host AI must treat them as operating constraints, not background notes.

### Constraint 1: Installation risk requires verification

- Trigger: Project evidence flags a installation risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/filecoin-project/filecoin-pin/issues/575
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 2: Runtime risk requires verification

- Trigger: Project evidence flags a runtime risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/filecoin-project/filecoin-pin/issues/579
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 3: Security or permission risk requires verification

- Trigger: Developers should check this security_permissions risk before relying on the project: Add CLI error-scenario smoke test matrix for devs
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: Add CLI error-scenario smoke test matrix for devs. Context: Observed when using node
- Why it matters: Developers may expose sensitive permissions or credentials: Add CLI error-scenario smoke test matrix for devs
- Evidence: failure_mode_cluster:github_issue | https://github.com/filecoin-project/filecoin-pin/issues/470
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 4: Security or permission risk requires verification

- Trigger: Project evidence flags a security or permission risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/filecoin-project/filecoin-pin/issues/470
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 5: Security or permission risk requires verification

- Trigger: Project evidence flags a security or permission risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/filecoin-project/filecoin-pin/issues/527
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 6: Installation risk requires verification

- Trigger: Developers should check this installation risk before relying on the project: Extract upload-action into a standalone repository for independent versioning
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: Extract upload-action into a standalone repository for independent versioning. Context: Observed when using node
- Why it matters: Developers may fail before the first successful local run: Extract upload-action into a standalone repository for independent versioning
- Evidence: failure_mode_cluster:github_issue | https://github.com/filecoin-project/filecoin-pin/issues/527
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 7: Installation risk requires verification

- Trigger: Developers should check this installation risk before relying on the project: feat: add compact summary view to `data-set list`
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: feat: add compact summary view to `data-set list`. Context: Observed when using node
- Why it matters: Developers may fail before the first successful local run: feat: add compact summary view to `data-set list`
- Evidence: failure_mode_cluster:github_issue | https://github.com/filecoin-project/filecoin-pin/issues/578
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 8: Installation risk requires verification

- Trigger: Developers should check this installation risk before relying on the project: v0.22.1
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.22.1. Context: Observed when using node
- Why it matters: Upgrade or migration may change expected behavior: v0.22.1
- Evidence: failure_mode_cluster:github_release | https://github.com/filecoin-project/filecoin-pin/releases/tag/v0.22.1
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 9: Installation risk requires verification

- Trigger: Developers should check this installation risk before relying on the project: v0.23.2
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.23.2. Context: Observed when using node
- Why it matters: Upgrade or migration may change expected behavior: v0.23.2
- Evidence: failure_mode_cluster:github_release | https://github.com/filecoin-project/filecoin-pin/releases/tag/v0.23.2
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 10: Installation risk requires verification

- Trigger: Project evidence flags a installation risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/filecoin-project/filecoin-pin/issues/578
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.
