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
25 changes: 8 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,28 +53,19 @@ between components on a pixel-art canvas. Click any node to drill into its sub-f
## Try it in 60 seconds

```bash
git clone https://github.com/naorsabag/OpenHop.git
cd OpenHop
npm install # installs deps and builds the CLI bundle
cd packages/cli && npm link && cd ../..
npm run dev # API :8787 + web UI :8788
npx openhop demo
```

In another terminal:

```bash
openhop push examples/auth-flow.yaml
# → prints a URL. Open it.
```
That's it. The CLI starts the API + web UI on `localhost:8787` / `:8788`, posts a starter flow, and opens your browser. Press Ctrl-C to stop.

## Install

| Scenario | Command |
| ---------------------------- | --------------------------------------------------------- |
| **Try locally (no install)** | Clone this repo, `npm install`, `npm run dev`. See above. |
| **Use the CLI globally** | After `npm install`, `cd packages/cli && npm link` |

> npm, plugin-registry, and `npx openhop init` install paths are in progresstrack [#18–#37](https://github.com/naorsabag/OpenHop/issues) for launch-readiness.
| Scenario | Command |
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| **One-shot demo** | `npx openhop demo` — boots everything and opens the browser |
| **Long-lived local server** | `npx openhop serve` — API + web UI, no starter flow (or `npm install -g openhop` first if you'd rather have the global `openhop` binary) |
| **Install the agent skill** | `npx openhop init` — copies `SKILL.md` into every detected AI client |
| **Run from source (contributors)** | `git clone … && npm install && npm run dev`see [Contributing](#contributing) |

## Give your agent the skill

Expand Down
8 changes: 8 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Contributor-only convenience. End users should run `npx openhop demo`
# (or `openhop serve`) instead — the npm package ships a self-contained
# server + web UI and does not need a repo checkout.
#
# This compose file mounts the source tree, runs `npm install` inside a
# Node container, and starts the workspace dev script. Use it when you
# want to hack on OpenHop in an isolated container without installing
# Node locally.
services:
openhop:
image: node:22-alpine
Expand Down
Loading
Loading