@webxcli/cli

Access your terminal from the browser. Run the agent on any machine you own, then connect to that machine's shell from the WebXCLI web dashboard.

Install

npm install -g @webxcli/cli

This installs the webxcli command.

Requires Node.js 20 or newer.

Usage

webxcli login          # authenticate via the browser
webxcli up             # register this machine and start the agent
webxcli ls             # list your machines
webxcli <machine-name> # connect to a machine's shell
webxcli logout         # clear stored credentials

Getting started

Authenticate first. This opens your browser and waits for the callback on a temporary local port:

webxcli login

Then start the agent on the machine you want to reach:

webxcli up

Leave that running. The machine now appears in your dashboard and in webxcli ls, and you can open a shell on it from the browser or from another terminal:

webxcli my-laptop

Configuration

| Variable | Default | Description | | ------------- | --------------------- | -------------------------------- | | WEBXCLI_URL | https://webxcli.com | Base URL of the WebXCLI web app. |

Point the CLI at a self-hosted or local instance by setting WEBXCLI_URL:

WEBXCLI_URL=http://localhost:5173 webxcli login

Credentials are stored in ~/.webxcli/credentials.json with owner-only permissions.

License

MIT © Carlos Santos