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
16 changes: 13 additions & 3 deletions .github-openclaw-intelligence/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Open a [GitHub Issue](../../issues) describing:

1. Fork the repository and create a branch from `main`.
2. Make your changes in small, reviewable increments.
3. Test locally with `cd .github-openclaw-intelligence && bun install` and verify dependencies install cleanly.
3. Install and verify locally using the commands under Development Setup.
4. Open a pull request with a clear description of what changed and why.

---
Expand All @@ -51,14 +51,24 @@ See the [README](README.md#project-structure) for a detailed breakdown of every

## Development Setup

1. Install [Bun](https://bun.sh).
1. Install [Bun](https://bun.sh) 1.4.2 and [Node.js](https://nodejs.org/) 24.16 or newer within the Node 24 LTS line.
2. Clone the repository.
3. Install dependencies:
```bash
cd .github-openclaw-intelligence && bun install
cd .github-openclaw-intelligence
bun install --frozen-lockfile
bun lifecycle/preflight.ts
bun run build
bun run test
bun run chat --help
bun audit
```
4. Add an LLM API key as a repository secret (see [Supported Providers](README.md#supported-providers)).

The validation workflow runs these credential-free checks on pushes to `main` and
pull requests, including in the template repository where agent execution is
intentionally disabled. Live model responses still require a configured provider.

---

## Style and Conventions
Expand Down
22 changes: 16 additions & 6 deletions .github-openclaw-intelligence/PACKAGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,15 @@
| Package | Version | Description |
|---------|---------|-------------|
| [@buape/carbon](https://github.com/buape/carbon) | ^0.16.0 | Discord UI component library required by OpenClaw's bundled Discord channel plugin. The plugin is eagerly loaded during CLI bootstrap even when using `--local` mode. |
| [@larksuiteoapi/node-sdk](https://github.com/larksuite/node-sdk) | ^1.70.0 | Lark/Feishu API SDK required by OpenClaw's bundled Feishu channel plugin. The plugin is eagerly loaded during CLI bootstrap via `jiti`, which resolves modules from the project root — so this must be a direct dependency to ensure top-level hoisting. |
| [openclaw](https://github.com/openclaw/openclaw) | ^2026.6.11 | Multi-channel AI gateway with extensible messaging integrations. Provides the `openclaw agent --local` CLI command that powers the OpenClaw Intelligence system — it processes prompts, interacts with LLM providers, and manages conversation sessions. |
| [@larksuiteoapi/node-sdk](https://github.com/larksuite/node-sdk) | ^1.74.0 | Lark/Feishu API SDK required by OpenClaw's bundled Feishu channel plugin. The plugin is eagerly loaded during CLI bootstrap via `jiti`, which resolves modules from the project root — so this must be a direct dependency to ensure top-level hoisting. |
| [ansi-regex](https://github.com/chalk/ansi-regex) | ^6.3.0 | Strips ANSI escape sequences from local chat output. |
| [marked](https://github.com/markedjs/marked) | ^15.0.12 | Markdown parser for local chat; retained on the latest compatible major because `marked-terminal@7.3.0` requires `marked <16`. |
| [marked-terminal](https://github.com/mikaelbr/marked-terminal) | ^7.3.0 | Renders Markdown in the terminal. |
| [openclaw](https://github.com/openclaw/openclaw) | ^2026.9.5 | Multi-channel AI gateway with extensible messaging integrations. Provides the `openclaw agent --local` CLI command that powers the OpenClaw Intelligence system — it processes prompts, interacts with LLM providers, and manages conversation sessions. |

`bun.lock` records the tested dependency graph. Install with `bun install --frozen-lockfile`
to reproduce it. The `ws` override uses 8.21.3 because `@buape/carbon@0.16.0`
pins a vulnerable 8.20.0 release; remove the override once upstream uses a patched version.

### OpenClaw Feature Surface

Expand All @@ -28,6 +35,10 @@ Beyond the CLI binary, OCI uses the following OpenClaw feature categories:
| Environment isolation | `OPENCLAW_HOME`, `OPENCLAW_OAUTH_DIR` | Agent home and credential separation |
| Compaction | `.pi/settings.json` `compaction` | Automatic context compaction for long conversations (`keepRecentTokens: 32000`) |

Both runners forward `compaction.enabled` and `keepRecentTokens`. The legacy
`reserveTokens` setting is retained for existing configuration files but is no
longer forwarded: OpenClaw 2026.9.5 rejects it and manages its own reserve budget.

See [docs/analysis/openclaw-feature-utilization.md](docs/analysis/openclaw-feature-utilization.md) for a full audit of used vs. available features.

## Infrastructure Dependencies
Expand All @@ -39,8 +50,8 @@ These are not package dependencies but are required for the system to function:
| [GitHub Actions](https://github.com/features/actions) | The sole compute runtime. Issue, pull-request, comment, and scheduled events trigger a workflow that runs the AI agent. No external servers or containers are needed. |
| [GitHub Issues](https://docs.github.com/en/issues) | Used as the conversation interface. Each issue or pull request maps to a persistent AI conversation thread. |
| [Git](https://git-scm.com/) | All session state, conversation history, and agent edits are committed to the repository. Git serves as the memory and storage layer. |
| [Bun](https://bun.sh) | JavaScript/TypeScript runtime used to execute the agent orchestrator and install dependencies. |
| [Node.js](https://nodejs.org/) | Required by the OpenClaw CLI binary (>= 22). Installed alongside Bun in the workflow. |
| [Bun](https://bun.sh) | Bun 1.4.2 executes the agent orchestrator and installs dependencies. |
| [Node.js](https://nodejs.org/) | Required by the OpenClaw CLI binary (>=24.16.0 <25 or >=26.1.0). The workflow installs Node 24 LTS before dependency installation and tests. |
| [gh CLI](https://cli.github.com/) | GitHub's official CLI tool, used by the agent lifecycle scripts to interact with the GitHub API (fetching issues, posting comments, managing reactions). |

## GitHub Actions Workflow Dependencies
Expand All @@ -51,7 +62,7 @@ These are referenced in `.github/workflows/`:
|--------|----------|-------------|
| [actions/checkout@v7](https://github.com/actions/checkout) | agent | Checks out the repository so the agent can read and write files. |
| [oven-sh/setup-bun@v2](https://github.com/oven-sh/setup-bun) | agent | Installs the Bun runtime in the GitHub Actions environment. |
| [actions/setup-node@v6](https://github.com/actions/setup-node) | agent | Installs Node.js 24 for the OpenClaw CLI binary. |
| [actions/setup-node@v7](https://github.com/actions/setup-node) | agent, validation | Installs Node.js 24 for the OpenClaw CLI binary. |
| [actions/cache@v6](https://github.com/actions/cache) | agent | Caches `node_modules` keyed on the `bun.lock` hash to speed up dependency installation. |
| [actions/configure-pages@v6](https://github.com/actions/configure-pages) | public fabric | Configures GitHub Pages deployment. |
| [actions/upload-pages-artifact@v5](https://github.com/actions/upload-pages-artifact) | public fabric | Uploads the static site artifact from `.github-openclaw-intelligence/public-fabric/`. |
Expand All @@ -78,7 +89,6 @@ These are pulled in transitively by `openclaw`:
| Package | Description |
|---------|-------------|
| `@anthropic-ai/sdk` | Official Anthropic API client for Claude models. |
| `@aws-sdk/client-bedrock` | AWS Bedrock client for accessing models via AWS infrastructure. |
| `openai` | Official OpenAI API client. |
| `@google/genai` | Google's Generative AI SDK for Gemini models. |
| `express` | Web framework used by OpenClaw's gateway server. |
Expand Down
8 changes: 4 additions & 4 deletions .github-openclaw-intelligence/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ Talk to the **same agent from your terminal** — no GitHub Issues, no Actions,
### Quick Start

```bash
# 1. Install Bun and Node.js (once)
# OpenClaw requires Node.js >=22.22.3 <23, >=24.15.0 <25, or >=25.9.0
# 1. Install Bun 1.4.2 and Node.js (once)
# OpenClaw requires Node.js >=24.16.0 <25 or >=26.1.0 (Node 24 LTS recommended)
# Bun: https://bun.sh
# Windows: powershell -c "irm bun.sh/install.ps1 | iex"
# macOS/Linux: curl -fsSL https://bun.sh/install | bash
Expand Down Expand Up @@ -148,7 +148,7 @@ Highest precedence first: environment variables, then `.pi/settings.json`, then
| Symptom | Fix |
|---------|-----|
| `openclaw binary not found` | Run `bun install` inside `.github-openclaw-intelligence/` |
| `missing node:sqlite` | Install a supported Node.js version (Node 24.15+ recommended). OpenClaw cannot run under Bun. |
| `missing node:sqlite` | Install a supported Node.js version (Node 24.16+ recommended). OpenClaw cannot run under Bun. |
| `Set-Location : A positional parameter cannot be found that accepts argument 'run'` | You are passing `bun run chat` to PowerShell's `cd`. Run `Set-Location .\.github-openclaw-intelligence` first, then run `bun run chat` as a separate command. |
| `Integrity check failed for tarball` during install | `bun pm cache rm && bun install` |
| Missing API key prompt | Set the provider's env var (see [Supported Providers](#supported-providers)), or choose the LM Studio scan option |
Expand Down Expand Up @@ -280,7 +280,7 @@ Edit `.github-openclaw-intelligence/.pi/settings.json` to change the LLM provide

Settings are validated against `config/settings.schema.json` during the preflight step.

The provider, model, thinking level, timeout, and compaction values are passed explicitly to OpenClaw, ensuring the committed settings are respected regardless of host-level configuration on the runner image.
The provider, model, thinking level, timeout, and supported compaction values are passed explicitly to OpenClaw, ensuring the committed settings are respected regardless of host-level configuration on the runner image. The legacy `compaction.reserveTokens` field is accepted but ignored: OpenClaw now manages its own reserve budget. `compaction.enabled` and `keepRecentTokens` remain supported.

### Supported Providers

Expand Down
2 changes: 1 addition & 1 deletion .github-openclaw-intelligence/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.1.4
1.1.5
Loading