GitHub

The browser commands

Show a reading to the person in the browser, and inspect the panes that are open.

On this page

Every command below comes from the CLI's own contract in release 0.5.0. Run archboard help <command> for the same words at your terminal.

Command What it does
browser Inspect or control the connected browser session
browser panes What every pane is showing and reading
browser open Open a second browser pane
browser close Close one browser pane
browser show Show a canonical reading in one pane

browser #

Inspect or control the connected browser session

archboard browser needs a subcommand. Without one, it refuses with exit 2.

Examples

Terminal window
archboard browser panes

browser panes #

What every pane is showing and reading

  • Needs the server
  • Reads only

Synopsis

archboard browser panes [--url <url>]

Reports, for each pane

  • Where it sits.
  • Which model and variant it shows.
  • Which view it is read through.
  • What the user has picked out.

This is view state only, never model content.

Each pane names its repository and checkout, and own says whether it shows the vault that a command run in this directory finds. It needs no vault. Where none is found, no pane is own.

Arguments

Argument What it does
--url <url> The Archboard server to talk to; overrides ARCHBOARD_URL Default http://127.0.0.1:4242.

Examples

Terminal window
archboard browser panes
archboard --text browser panes

Output

  • The panes report

Exit codes

Exit When
0 Success The command did what it said. Its output is above.

Refusals

Exit Refusal
3 SERVER_UNREACHABLE The Archboard server could not be reached or started.

browser open #

Open a second browser pane

  • Needs the server
  • Needs a browser pane
  • Reads only

Synopsis

archboard browser open [--url <url>]

Splits the connected browser canvas; the new pane inherits the displayed reading. When no browser is connected, it opens the canvas in the default browser instead and waits for its pane.

Arguments

Argument What it does
--url <url> The Archboard server to talk to; overrides ARCHBOARD_URL Default http://127.0.0.1:4242.

Examples

Terminal window
archboard browser open

Output

  • Opened pane

Exit codes

Exit When
0 Success The command did what it said. Its output is above.

Refusals

Exit Refusal
3 SERVER_UNREACHABLE The Archboard server could not be reached or started.
4 BROWSER_REQUIRED The operation needs an open browser pane.

browser close #

Close one browser pane

  • Needs the server
  • Needs a browser pane
  • Reads only

Synopsis

archboard browser close <pane> [--url <url>]

Takes one reading off screen without changing the architecture.

Arguments

Argument What it does
<pane> required Which pane to close: left, right, top, bottom, focused, primary, a position or a pane id
--url <url> The Archboard server to talk to; overrides ARCHBOARD_URL Default http://127.0.0.1:4242.

Examples

Terminal window
archboard browser close right

Output

  • Closed pane

Exit codes

Exit When
0 Success The command did what it said. Its output is above.

Refusals

Exit Refusal
3 SERVER_UNREACHABLE The Archboard server could not be reached or started.
4 BROWSER_REQUIRED The operation needs an open browser pane.

browser show #

Show a canonical reading in one pane

  • Needs the server
  • Needs a browser pane
  • Reads only

Synopsis

archboard browser show [<model>] [--pane <value>] [--module <value>] [--scope <value>] [--state <value>] [--checkpoint <value>] [--flow <value>] [--walkthrough <value>] [--preview <value>] [--bookmark <value>] [--legacy-address <value>] [--input <value>] [--against <id|name>] [--grammar <value>] [--beat <index>] [--focus <id>] [--hide-kind <id>] [--expand <id>] [--url <url>] [-C <dir>] [--as-session <thread>]

Resolves the exact model, module, state, flow, or walkthrough before moving the existing pane. An agent show preserves the browser's shown conversation. When no browser is connected, it opens the canvas on the repository in the default browser and waits for its pane.

Arguments

Argument What it does
<model> The optional model identity or name
--pane <value> The explicit pane selector
--module <value> The explicit module selector
--scope <value> The explicit scope selector
--state <value> The explicit state selector
--checkpoint <value> The explicit checkpoint selector
--flow <value> The explicit flow selector
--walkthrough <value> The explicit walkthrough selector
--preview <value> The explicit preview selector
--bookmark <value> The explicit bookmark selector
--legacy-address <value> The explicit legacyAddress selector
--input <value> The explicit input selector
--against <id|name> Compare against one explicit state or complete checkpoint identity
--grammar <value> The diagram grammar One of architecture, sequence, flowchart.
--beat <index> The zero-based walkthrough beat
--focus <id> repeatable The focus identities
--hide-kind <id> repeatable The hideKinds identities
--expand <id> repeatable The expand identities
--url <url> The Archboard server to talk to; overrides ARCHBOARD_URL Default http://127.0.0.1:4242.
-C <dir> Find the vault from this directory instead of the working directory, the way git -C finds a repository; other relative paths still resolve against the working directory
--as-session <thread> The agent session acting, so it is not told about what it did itself

Examples

Terminal window
archboard browser show --pane A --module Gateway
archboard browser show Shop --pane B --grammar sequence --flow Request

Output

  • What the pane is showing now

Exit codes

Exit When
0 Success The command did what it said. Its output is above.

Refusals

Exit Refusal
3 SERVER_UNREACHABLE The Archboard server could not be reached or started.
4 BROWSER_REQUIRED The operation needs an open browser pane.
2 VAULT_NOT_FOUND The command found no vault from the working directory or the directory -C names. Inside a checkout, only <root>/.archboard/vault counts. Outside one, the nearest enclosing <dir>/.archboard/vault counts. In a checkout with no vault, the refusal names each known vault whose models bind the checkout's repository, as the -C to give. The command changed nothing.
2 VAULT_REQUIRED A server call named no vault. A command names the vault it finds from the working directory or -C <dir>.
2 VAULT_UNREADABLE The vault the command found is not a directory the server can read. Nothing was created.
Docs

Type to search every page, command and schema.