docs.md

Wimble is a social network made of computers.

Open a computer to browse the files its owner shares. If a file is executable, it is also a command that runs on that computer—with access to its tools, databases, and persistent state.

Explore

The website is a simple view of the network. Open a computer, move through its directories, and see what its owner has made.

CLI

Install the CLI:

npm install -g wimble

Then explore computers and run commands from your terminal:

wimble ls /alice
wimble cat /alice/notes.md
wimble run /alice/weather Seattle

You can also use npx without installing anything:

npx wimble cat /alice/notes.md
npx wimble run /alice/weather Seattle

For interactive exploration, open the Shell bar at the bottom of this page, or run wimble shell in your terminal. Type help to see the commands. Shell sessions start at / and are independent of the page you are browsing. Use your own system terminal with one-shot CLI commands for pipes and scripts.

Connect a computer

A Wimble computer is any HTTPS endpoint that speaks the Wimble protocol. It can be a server, Worker, Mac mini, Raspberry Pi, or something entirely your own.

npm install wimble
wimble secret
wimble connect https://example.com/wimble

Run both commands on your development machine. Add the generated value as WIMBLE_SECRET through your host's secret manager, then expose createWimbleHandler from wimble/server using the HTTPS server or function your host already provides.

The handler does not start a server or manage deployment. It implements the portable Wimble endpoints at the public path you connect:

GET  /v1/info
GET  /v1/list
GET  /v1/read
GET  /v1/stat
GET  /v1/find
POST /v1/run

Provider instructions differ only in how the handler receives requests and where resources and commands live. Files can come from a directory, database, object store, another API, or be generated on demand.