Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .worktreeinclude
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/.env
/.env.local
.rokit/.env
/.repos/effect/
21 changes: 15 additions & 6 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,16 @@ Keep it platform-focused, typed, and useful for both humans and agents.
- Keep app journeys, content IDs, account data, and product assertions out of
the generic harness.

## Learning more about the Effect

This repository uses the Effect Typescript library.

Before writing any Effect code, first read `node_modules/effect/AGENTS.md`
**completely**, and follow the links in the file when required.

If you need to learn more about particular Effect apis and concepts that the
guide doesn't cover, search through the source code in `node_modules/effect/src`.

## Sharp Edges

- Missing config/env and child-command failures should not print stack traces.
Expand All @@ -62,8 +72,8 @@ Keep it platform-focused, typed, and useful for both humans and agents.
- Avoid sleeps in generic commands. App repos can add meaningful wait/assert
loops around `rokit` primitives.
- Release details live in `docs/DISTRIBUTION.md`; debugging details live in
`docs/DEBUGGING.md`; readiness details live in `docs/READINESS.md`;
consumer skill guidance lives in `skills/rokit/SKILL.md`.
`docs/DEBUGGING.md`; consumer skill guidance lives in
`skills/rokit/SKILL.md`.

## When Contracts Change

Expand All @@ -75,10 +85,9 @@ Keep it platform-focused, typed, and useful for both humans and agents.

## Worktrees

`.worktreeinclude` carries env and `.repos/effect` into managed worktrees;
Claude symlinks `.repos`. Run `vp install`, `vp run hooks:install`, and
`vp run verify`. If device config is missing, copy `.env.example` to `.env` or
`.rokit/.env`.
`.worktreeinclude` carries local env files into managed worktrees. Run
`vp install`, `vp run hooks:install`, and `vp run verify`. If device config is
missing, copy `.env.example` to `.env` or `.rokit/.env`.

## Checks

Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

## Install

Requires Node `>=24.14.0`; install it in a consumer repo with:
Requires Node `>=24.18.0`; install it in a consumer repo with:

```bash
pnpm add -D @putdotio/rokit
Expand Down Expand Up @@ -181,7 +181,6 @@ artifacts.
- [Contributing](./CONTRIBUTING.md)
- [Roku debugging](./docs/DEBUGGING.md)
- [Distribution](./docs/DISTRIBUTION.md)
- [Agent readiness](./docs/READINESS.md)
- [rokit skill](./skills/rokit/SKILL.md)
- [Security](./SECURITY.md)

Expand Down
4 changes: 2 additions & 2 deletions docs/DISTRIBUTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ Release writes use the `putio-releaser` installation token. The default `GITHUB_
The npm package includes `dist`, `README.md`, `docs`, `examples`, `skills`,
`AGENTS.md`, `CONTRIBUTING.md`, and `SECURITY.md`. The docs, consumer skill, and
generic live probe are included so agents consuming the package can inspect
readiness, distribution, security, and generic Roku proof mechanics without
cloning extra private context.
distribution, security, and generic Roku proof mechanics without cloning extra
private context.

## Release Smoke

Expand Down
91 changes: 0 additions & 91 deletions docs/READINESS.md

This file was deleted.

7 changes: 3 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,21 +50,20 @@
"hooks:install": "git config core.hooksPath .git-hooks",
"live:smoke": "vp pack src/index.ts src/rokit.ts --dts && node dist/rokit.mjs check",
"live:probe": "scripts/live-probe.sh",
"prepare": "./scripts/prepare-effect.sh",
"prepack": "vp pack src/index.ts src/rokit.ts --dts",
"smoke": "vp pack src/index.ts src/rokit.ts --dts && node dist/rokit.mjs --version && node dist/rokit.mjs --help >/dev/null",
"test": "vp pack src/index.ts src/rokit.ts --dts && vp test run --passWithNoTests",
"typecheck": "tsc --noEmit",
"verify": "vp check . && tsc --noEmit && vp pack src/index.ts src/rokit.ts --dts && node dist/rokit.mjs --version && node dist/rokit.mjs --help >/dev/null && vp test run --passWithNoTests && npm pack --dry-run"
},
"dependencies": {
"@effect/platform-node": "4.0.0-beta.102",
"effect": "4.0.0-beta.102",
"@effect/platform-node": "4.0.0-beta.107",
"effect": "4.0.0-beta.107",
"jszip": "^3.10.1",
"roku-deploy": "3.18.2"
},
"devDependencies": {
"@effect/vitest": "4.0.0-beta.102",
"@effect/vitest": "4.0.0-beta.107",
"@types/node": "^26.1.2",
"typescript": "^7.0.2",
"vite": "catalog:",
Expand Down
Loading