wbsb-remote-edit

A tool that lets you write articles for wbsb.dev in your favorite text editor.

日本語

Usage

1. Open wbsb.dev.
2. Open the browser extension popup and turn on the Auto connect switch.
3. Run the command in the CLI.
4. Once both the browser extension and CLI are connected to the bridge server, it is ready to use.

CLI: Commands

All commands share the following options.

• --addr: The address of the bridge server to start, in host:port format. By default, 127.0.0.1:8787 is used.
• --allow-origin: Origins that are allowed to connect to the bridge server.
• --path: The endpoint path for the bridge WebSocket server. By default, /ws is used.

edit

wbsb-remote-edit edit

Start editing an article in your favorite text editor.

Options

• --title: The article title.
• --editor: The editor to use. By default, $EDITOR is opened.
• --file: The Markdown file to use as the editor initial body.
• --save-to: Save the edited Markdown to the specified file or directory.

push

wbsb-remote-edit push README.md

Send Markdown to the browser editor.

Arguments

• markdown-path: The Markdown file to send to the browser editor. This argument is required.
• --title: The article title.

pull

wbsb-remote-edit pull Article.md

Receive an article from the browser editor.

Arguments

• output-path: The destination file or directory. This argument is required.

CLI: Download

Download and extract the file from Release.

For Windows

wbsb-remote-edit-cli--windows-.zip

For Mac

wbsb-remote-edit-cli--darwin-.tar.gz

For Linux

wbsb-remote-edit-cli--linux-.tar.gz

Browser Extension: Features

Endpoint Input

This endpoint is used as the bridge server.

Auto Connect Switch

While this switch is on, the extension keeps connecting to the bridge server specified in the Endpoint input.

Browser Extension: Installation

Download and install the file from Release.

For Chrome

wbsb-remote-edit-chrome-.zip

For Firefox

wbsb-remote-edit-firefox-.xpi

Development: Environment Setup

nix develop or nix-direnv

Development: Build

nix build .# -o build/