foldrun 0.3.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 foldrun contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,149 @@
+# foldrun
+
+**Agents are just folders.** An agent is a folder with a markdown file in it. A flow is
+a numbered list naming agents. You write them, read them, diff them in a pull
+request, and run them from this CLI.
+
+Everything here works on a plain folder — no account, no server, no network
+beyond the model call itself.
+
+```sh
+npm install -g foldrun
+export ANTHROPIC_API_KEY=sk-ant-…
+
+foldrun init competitor-watch
+cd competitor-watch
+foldrun check          # free — no model calls
+foldrun run publish
+```
+
+Requires Node 22 or newer. `init` and `check` need no API key.
+
+## What `init` gives you
+
+```
+competitor-watch/
+├── AGENTS.md                    what every agent here shares
+├── agents/
+│   ├── researcher/agent.md
+│   └── writer/agent.md
+├── flows/publish.md             the steps, in order
+├── knowledge/house-style.md     given to them; they may read, never write
+├── memory/what-worked.md        what they learned; they write here
+└── evals/writer-quality.md      what "good" means, as a test
+```
+
+An agent is frontmatter for the machine and prose for the model:
+
+```markdown
+---
+name: researcher
+description: Finds one thing worth writing about, and says why.
+model: fast
+effort: high
+tools:
+  - web
+  - read
+---
+
+Pick exactly one topic, in a short paragraph, and say who it helps and why now.
+Do not write the article.
+```
+
+A flow is the numbers, not the order of the lines — same number runs at the
+same time, different numbers run one after another:
+
+```markdown
+---
+name: publish
+trigger: manual
+---
+
+1. [[researcher]] — find one topic worth writing about
+2. [[writer]] — draft it
+```
+
+`model:` takes a tier — `fast`, `default`, `max` — rather than a model id, so a
+workspace doesn't rot when models are renamed. `effort:` is the other half: not
+which brain, but how long it thinks.
+
+## Giving an agent real capabilities
+
+A **script tool** is a folder holding its definition and the program it runs:
+
+```
+tools/wordcount/
+├── tool.md      transport: script · run: run.py · args: {text: …}
+└── run.py       a real file — lint it, test it, run it by hand
+```
+
+The agent calls it by name with typed arguments and never composes a shell
+command. Arguments arrive as `--flags`, stdout comes back, a non-zero exit is a
+failure. An agent grants it with `tools: [wordcount]`.
+
+An **HTTP tool** is one markdown file declaring a base URL, allowed methods and
+headers, with `${SECRET}` placeholders the platform resolves at call time — so
+the model gets the capability and never sees the key. An **MCP server** is
+declared the same way.
+
+## Commands
+
+| | |
+|---|---|
+| `foldrun init [dir]` | create a workspace you can run immediately |
+| `foldrun check [dir]` | validate agents, flows, tools, evals and knowledge |
+| `foldrun run <target>` | run an agent or a flow |
+| `foldrun eval [name]` | run one eval, or all of them |
+| `foldrun extract [dir]` | move single-file script tools into folders |
+| `foldrun probe <model>` | live check: can this model hold a tool loop here? |
+| `foldrun logs [run-id]` | recent runs, or one run's full event trail |
+| `foldrun secrets set NAME` | store a secret, prompted and never echoed |
+| `foldrun deploy [dir]` | push a workspace into an installation |
+| `foldrun invoke <flow>` | start a flow on a running platform (`--watch` streams its trace) |
+| `foldrun open [page]` | the dashboard for this workspace, in the browser |
+| `foldrun login` | sign this machine in from the browser — no key to copy |
+| `foldrun whoami` | who you are on the platform: account, role, workspaces |
+| `foldrun keys ls` | the account's API keys — also `create <label>`, `revoke <id>` |
+
+`foldrun --help` lists every flag.
+
+**`check` is the one to run in CI.** It costs nothing and catches what
+otherwise surfaces as a confidently wrong answer at 3am: a step naming an agent
+that doesn't exist, a tool whose program isn't on disk, an eval pointing at a
+flow that was renamed, a knowledge bundle whose index disagrees with its own
+files.
+
+## Secrets
+
+Declared by name in an agent's frontmatter, never by value:
+
+```yaml
+secrets:
+  - SLACK_WEBHOOK_TOKEN
+```
+
+`foldrun secrets set SLACK_WEBHOOK_TOKEN` prompts for it and stores it
+encrypted. Declared secrets are injected as environment variables into the
+agent's scripts and substituted into HTTP headers. They are never returned by
+an API and never reach the model.
+
+## Running it somewhere else
+
+`foldrun deploy` pushes a workspace into an installation — your own, or a
+hosted one — and `foldrun invoke <flow> --wait` starts a flow there and prints
+the result. A deploy never touches run history, state, secrets, or memory an
+agent wrote: those belong to the installation, not to your git repo.
+
+```sh
+foldrun login                    # approve it in the browser, once per machine
+foldrun deploy
+foldrun invoke publish --wait
+```
+
+`foldrun login --url https://your-platform` signs in to your own installation.
+In CI, set `FOLDRUN_URL` and `FOLDRUN_TOKEN` instead — the environment always
+wins over the credentials file, so a job never reads one from disk.
+
+## License
+
+Apache-2.0.

package/bin/foldrun.mjs

@@ -0,0 +1,165 @@
+#!/usr/bin/env node
+// foldrun — the open-source CLI.
+//
+// Local-first by design: every command here works on a plain folder with no
+// account, no server and no network beyond the model call itself. That is the
+// point. A framework whose free version is a crippled demo gets no adoption,
+// and adoption is the only reason a hosted version has customers.
+//
+//   foldrun init  [dir]     scaffold a working workspace
+//   foldrun check [dir]     validate it — no model calls, no cost
+//   foldrun run   <target>  run an agent or a flow
+//   foldrun eval  [name]    run evals
+//   foldrun probe <model>   can this model hold a tool loop? (live check)
+//   foldrun logs  [run-id]  recent runs, or one run's full event trail
+//   foldrun secrets <verb>  set / ls / rm — the vault, from the terminal
+//   foldrun deploy [dir]    push a workspace into an installation
+//   foldrun invoke <flow>   start a flow on a running platform
+//   foldrun open  [page]    the dashboard for this workspace
+//   foldrun login           sign this machine in from the browser
+//   foldrun whoami          who the platform thinks this terminal is
+//   foldrun keys  <verb>    ls / create / revoke — the account's API keys
+//
+// `check` is the one to run in CI: it catches the mistakes that otherwise only
+// show up as a confidently wrong answer at 3am.
+
+import { fileURLToPath } from "node:url";
+import path from "node:path";
+import process from "node:process";
+
+const HERE = path.dirname(fileURLToPath(import.meta.url));
+
+// Node warns about stripping types from a package without "type": "module".
+// True, and not the user's problem — they asked to run an agent.
+process.removeAllListeners("warning");
+process.on("warning", () => {});
+
+const [, , command, ...rest] = process.argv;
+
+const HELP = `foldrun — agents are just folders
+
+  foldrun init [dir]        create a workspace you can run immediately
+  foldrun check [dir]       validate agents, flows, tools, evals and knowledge
+  foldrun extract [dir]     move single-file script tools into folders (tool.md + run.*)
+  foldrun run <target>      run an agent or flow (target: name, or flow:name)
+  foldrun eval [name]       run one eval, or all of them
+  foldrun probe <model>     live check: can this model hold a tool loop here?
+  foldrun logs [run-id]     recent runs, or one run's full event trail
+  foldrun secrets set NAME  store a secret (prompted, never echoed) — also ls, rm
+  foldrun connect NAME      OAuth sign-in from the terminal, stored as an auto-refreshing secret
+  foldrun deploy [dir]      push a workspace into an installation
+  foldrun invoke <flow>     start a flow on a running platform (--to <workspace>)
+  foldrun open [page]       the dashboard for this workspace, in the browser
+
+Signing in
+  foldrun login             sign this machine in from the browser (--token <key> to skip it)
+  foldrun logout            forget this machine's key, and revoke it where allowed
+  foldrun whoami            who you are on the platform: account, role, workspaces
+  foldrun keys ls           the account's API keys — also create <label>, revoke <id>
+  foldrun --help
+
+Options
+  --workspace <dir>         the workspace folder (default: .)
+  --from <template>         start from a shipped template, e.g. templates/hello
+  --task "<text>"           the instruction for a manual run
+  --follow                  logs: keep tailing a live run (with --url: on the platform)
+  --value "<text>"          secrets set: skip the prompt (careful with shell history)
+  --account                 secrets: account scope instead of the workspace's
+  --wait                    invoke: hold on and print the result
+  --watch                   invoke: follow the run's trace here as it happens
+  --print                   open: print the URL only
+  --from <n>                invoke: start at step n; earlier steps are skipped
+  --no-browser              login, connect: print the address instead of opening it
+  --provider <name>         connect: google, github, microsoft or linkedin (fills the URLs)
+  --scopes "<a b c>"        connect: space-separated scopes (default: the provider's example)
+  --client-id / --client-secret  connect: the OAuth app (prompted if omitted; secret never echoed)
+  --port <n>                connect: loopback port for the redirect (default 8642 — register http://localhost:8642/callback on the app)
+  --authorize-url / --token-url  connect: a provider with no preset
+  --role <r>                keys create: viewer, editor (default) or admin
+  --for <workspace>         keys create: a deploy key for one workspace (--access read|write)
+
+Platform options (deploy, invoke, secrets, logs, keys)
+  --to <workspace>          workspace on the platform (deploy default: folder name)
+  --tenant <name>           account to deploy into (default: default, local only)
+  --data <dir>              the installation's data directory
+  --url <url>               a running platform (or FOLDRUN_URL, or where you last signed in)
+  --token <key>             API key for --url (or FOLDRUN_TOKEN, or the one from foldrun login)
+  --local                   deploy: into the installation on this machine, even when signed in
+  --commit <sha>            deploy: record which commit this is
+  --dry-run                 deploy: check and report, change nothing
+  --force                   deploy: deploy even while runs are in flight
+
+Nothing here needs an account. Set ANTHROPIC_API_KEY to run; init and check
+work without one. \`foldrun login\` is for the hosted platform, or your own.`;
+
+if (!command || command === "--help" || command === "-h") {
+  console.log(HELP);
+  process.exit(0);
+}
+
+// Flags first, so the workspace is known before anything loads the core:
+// single-workspace mode is an environment decision, read at import time.
+// Flags that take no value. Without the list, `--account --value X` read
+// `--value` as the account's argument and stored an empty secret; `--force
+// ./dir` swallowed the directory. A flag followed by another flag is also
+// boolean, so an unlisted switch at least does not eat its neighbour.
+const BOOLEAN_FLAGS = new Set(["account", "follow", "force", "oauth2", "wait", "watch", "print", "dry-run", "help", "no-browser", "local"]);
+const flags = {};
+const positional = [];
+for (let i = 0; i < rest.length; i++) {
+  if (!rest[i].startsWith("--")) {
+    positional.push(rest[i]);
+    continue;
+  }
+  const name = rest[i].slice(2);
+  const next = rest[i + 1];
+  if (BOOLEAN_FLAGS.has(name) || next === undefined || next.startsWith("--")) flags[name] = true;
+  else flags[name] = rest[++i];
+}
+
+// `deploy` is the one command that is not about a single folder: it reads a
+// source directory and writes into an installation, which has accounts and
+// many workspaces. Pinning FOLDRUN_WORKSPACE would collapse that layout to one
+// folder and send every deploy to the same place.
+const isDeploy = command === "deploy";
+
+// `init` and `check` take a directory; `run` and `eval` take the name of a
+// thing to run, so a directory there would be ambiguous — use --workspace.
+const takesDir = command === "init" || command === "check" || command === "extract";
+const workspace = path.resolve(
+  flags.workspace ?? (takesDir ? positional.shift() ?? "." : "."),
+);
+if (!isDeploy) process.env.FOLDRUN_WORKSPACE = workspace;
+
+// Where the secrets, keys and run store live.
+//
+// A workspace on a laptop keeps them inside itself, in `.foldrun/`. But a
+// workspace that belongs to an installation sits at
+// `<data>/<tenant>/workspaces/<name>`, and its secrets belong to the tenant,
+// two levels up — so pointing --workspace at one and defaulting to `.foldrun/`
+// opened an empty store beside it. Every declared secret came back missing,
+// and the error told you to add secrets that were already there.
+//
+// The layout says which case this is: a parent directory named `workspaces`
+// only happens in an installation.
+const parent = path.basename(path.dirname(workspace));
+const installationRoot =
+  parent === "workspaces" ? path.resolve(workspace, "..", "..", "..") : null;
+
+if (isDeploy) {
+  // The destination is an installation, so --data names it outright. Without
+  // one, dataRoot()'s own default applies: data/ at the project root.
+  if (flags.data) process.env.FOLDRUN_DATA = path.resolve(flags.data);
+} else {
+  process.env.FOLDRUN_DATA ??= installationRoot ?? path.join(workspace, ".foldrun");
+}
+
+const { run } = await import(path.join(HERE, "../src/commands.mjs"));
+
+try {
+  const code = await run(command, positional, flags, workspace);
+  process.exit(code ?? 0);
+} catch (err) {
+  console.error(`\n  ${err instanceof Error ? err.message : String(err)}\n`);
+  process.exit(1);
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "foldrun",
+  "version": "0.3.0",
+  "description": "Agents are just folders. Write them, check them, run them — on your machine.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "bin": {
+    "foldrun": "bin/foldrun.mjs"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "dependencies": {
+    "@foldrun/core": "^0.2.0"
+  },
+  "files": [
+    "bin",
+    "src",
+    "README.md"
+  ],
+  "scripts": {
+    "e2e": "FOLDRUN_E2E=1 FOLDRUN_DATA=$(mktemp -d /tmp/foldrun-e2e-XXXXXX) node --test --test-timeout=300000 tests/e2e.test.ts",
+    "test": "FOLDRUN_DATA=$(mktemp -d /tmp/foldrun-test-XXXXXX) node --test tests/cli-secrets.test.ts tests/cli-check-library.test.ts tests/cli-connect.test.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/foldrun-io/foldrun-cli.git"
+  },
+  "homepage": "https://foldrun.io",
+  "bugs": {
+    "url": "https://github.com/foldrun-io/foldrun-cli/issues"
+  },
+  "keywords": [
+    "agents",
+    "llm",
+    "markdown",
+    "workflows",
+    "claude"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}