mirror of
https://github.com/runablehq/mini-browser.git
synced 2026-09-20 13:45:46 +08:00
readme: add demo gif, runable.com link, and skills.sh install
- Add terminal recording showing skills add + mb commands workflow - Add badge links for npm, runable.com, and skills.sh - Restructure setup: agent skill (recommended) vs global CLI - Include VHS tape file for regenerating the gif
This commit is contained in:
@@ -2,14 +2,41 @@
|
||||
|
||||
Browser CLI for agents. Each command is a small Unix tool — reads args, writes stdout, composes with pipes and `&&`.
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/demo.gif" alt="mb demo — install, browse, snap, screenshot" width="860" />
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://www.npmjs.com/package/@runablehq/mini-browser"><img alt="npm" src="https://img.shields.io/npm/v/@runablehq/mini-browser"></a>
|
||||
<a href="https://runable.com/npm/@runablehq/mini-browser"><img alt="runable" src="https://img.shields.io/badge/runable.com-try%20it-blue"></a>
|
||||
<a href="https://skills.sh/runablehq/mini-browser/mini-browser"><img alt="skills.sh" src="https://img.shields.io/badge/skills.sh-install-green"></a>
|
||||
</p>
|
||||
|
||||
## Setup
|
||||
|
||||
### As an agent skill (recommended)
|
||||
|
||||
```bash
|
||||
npx skills add runablehq/mini-browser --all --global
|
||||
```
|
||||
|
||||
This installs the `mini-browser` skill for all your agents via [skills.sh](https://skills.sh/runablehq/mini-browser/mini-browser). Your agent will automatically know how to use `mb` commands.
|
||||
|
||||
### As a global CLI
|
||||
|
||||
```bash
|
||||
npm install -g @runablehq/mini-browser
|
||||
```
|
||||
|
||||
### Then start Chrome
|
||||
|
||||
```bash
|
||||
mb-start-chrome # starts Chrome with --remote-debugging-port=9222
|
||||
mb go "https://example.com"
|
||||
```
|
||||
|
||||
> **Try it online** at [runable.com](https://runable.com/npm/@runablehq/mini-browser) — no install needed.
|
||||
|
||||
Also ships `mb-restart-chrome` to kill and relaunch the debug Chrome instance.
|
||||
|
||||
For local development: `bun install && bun run build`, then use `node dist/mb.js`.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 904 KiB |
@@ -0,0 +1,52 @@
|
||||
# VHS tape for mini-browser demo
|
||||
# https://github.com/charmbracelet/vhs
|
||||
|
||||
Output assets/demo.gif
|
||||
|
||||
Set Shell "bash"
|
||||
Set FontSize 14
|
||||
Set Width 860
|
||||
Set Height 460
|
||||
Set Padding 16
|
||||
Set Theme "GitHub Dark"
|
||||
Set TypingSpeed 30ms
|
||||
Set CursorBlink false
|
||||
|
||||
Sleep 500ms
|
||||
|
||||
# Install the skill
|
||||
Type "npx skills add runablehq/mini-browser --all --global"
|
||||
Enter
|
||||
Sleep 5s
|
||||
|
||||
# List installed skills
|
||||
Type "npx skills ls"
|
||||
Enter
|
||||
Sleep 3s
|
||||
|
||||
# Start Chrome
|
||||
Type "mb-start-chrome"
|
||||
Enter
|
||||
Sleep 3s
|
||||
|
||||
# Navigate
|
||||
Type "mb go https://example.com"
|
||||
Enter
|
||||
Sleep 3s
|
||||
|
||||
# Extract text
|
||||
Type "mb text h1"
|
||||
Enter
|
||||
Sleep 2s
|
||||
|
||||
# Snap interactive elements
|
||||
Type "mb snap"
|
||||
Enter
|
||||
Sleep 2s
|
||||
|
||||
# Screenshot
|
||||
Type "mb shot screenshot.png"
|
||||
Enter
|
||||
Sleep 2s
|
||||
|
||||
Sleep 1s
|
||||
Reference in New Issue
Block a user