Skip to content
Open
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
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
OPENCLAW_HOME=/root/.openclaw
OPENCLAW_WORKSPACE=/root/.openclaw/workspace
76 changes: 54 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,74 @@
# sv
# OpenClaw Monitor

Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
A SvelteKit dashboard for inspecting a local OpenClaw installation in development mode.

## Creating a project
It is designed for the workflow where the app runs locally on the OpenClaw host, and you reach it through an SSH tunnel instead of deploying a static production build.

If you're seeing this, you've probably already done this step. Congrats!
## What it shows

```sh
# create a new project
npx sv create my-app
- OpenClaw runtime basics such as install version, default model, ACP backend, gateway mode, and tool profile
- Workspace facts such as memory file count and workspace state
- Channel and device summaries without exposing secrets
- Parsed highlights from `openclaw status`
- Installed skills discovered from workspace skills, built-in OpenClaw skills, and extension skills
- Cron jobs discovered from local OpenClaw cron state
- A sanitized OpenClaw config snapshot with secret-like fields redacted

## How it works

The app reads local files at request time on the server side. Machine-specific data is not committed to the repository.

By default it looks here:

- `OPENCLAW_HOME=/root/.openclaw`
- `OPENCLAW_WORKSPACE=/root/.openclaw/workspace`

Override those paths with environment variables if you want to point the monitor at another OpenClaw installation.

## Development

Install dependencies:

```bash
npm install
```

To recreate this project with the same configuration:
Run the dev server:

```sh
# recreate this project
npx sv@0.12.8 create --template minimal --types ts --install npm .
```bash
npm run dev -- --host 0.0.0.0 --port 4173
```

## Developing
Then forward the port from your local machine, for example:

```bash
ssh -L 4173:127.0.0.1:4173 your-server
```

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
## Environment

```sh
npm run dev
Copy `.env.example` if you want explicit paths:

# or start the server and open the app in a new browser tab
npm run dev -- --open
```bash
cp .env.example .env
```

## Building
Example:

```env
OPENCLAW_HOME=/root/.openclaw
OPENCLAW_WORKSPACE=/root/.openclaw/workspace
```

To create a production version of your app:
## Validation

```sh
```bash
npm run check
npm run build
```

You can preview the production build with `npm run preview`.
## Notes

> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
- The dashboard is intentionally local-first.
- Secret-like fields in `openclaw.json` are redacted before being returned to the UI.
- The monitor currently focuses on visibility and foundation for future dashboards rather than write actions.
Loading