Aller au contenu

Install ws and sign in

Ce contenu n’est pas encore disponible dans votre langue.

For builders starting on the Website Strategy platform. It covers the account, tools and sign-in a builder needs before making a first site. It takes about five minutes.

  • An Outport staff account. Outport is Sevenview’s sign-in for its own tools. The software page and ws both sign in with it, and the platform accepts work only from signed-in staff.
  • Git. ws uses Git to send and fetch a site’s files.
  • A phone or second browser, to open previews.

You do not need Node or a copy of the platform. The platform builds every page on its own servers.

  1. Sign in at https://outport.app.

  2. Install ws. Outport’s software page, https://outport.app/tools/software, has it for macOS and Linux. If you already have Outport’s out tool, out upgrade ws installs it too, and out upgrade keeps it up to date from then on. Check that it runs:

    Terminal window
    ws version
    ws 0.1.56

    Your number may be higher.

  3. Check that Git is installed:

    Terminal window
    git --version

    It prints a version number. If it says the command is not found, install Git first.

  4. Check that Git knows your name and email, which every commit records:

    Terminal window
    git config user.name
    git config user.email

    If either prints nothing, set it with git config --global user.name "Your Name" and git config --global user.email you@example.com.

  5. Sign in:

    Terminal window
    ws login
    Opening https://outport.app in your browser to sign in.

    Sign in with your Outport staff account in the browser. ws then prints the name you are signed in as, and stays signed in.

Step 5 is optional in a terminal: the first ws command that needs the platform opens the browser to sign in. A coding agent, or any command whose output goes to another program or uses --json, cannot open the browser. Sign in first with ws login --device, in the next section.

Sign in when the browser is on another computer

Section titled “Sign in when the browser is on another computer”

When the browser is on another machine, such as ws running on a server or over SSH, sign in with a code instead:

Terminal window
ws login --device
On another device, open https://outport.app/oauth/device and enter 55NB-64GH.
Signed in as Jordan Bell.

Open that address in any browser, sign in with your Outport staff account and type the code. Each sign-in prints a new code.

ws logout signs out.

ws has three environments built in, called profiles: production, staging and local.

Profile When to use it
production Real customers’ sites. An installed ws uses it by default, and every example in this guide runs on it.
staging Trying things on the test platform. Add --profile staging to any command.
local The platform running on your own computer, for platform developers. It needs no sign-in.

ws profile show prints the profile in use. ws profile use staging makes staging the default, and the WS_PROFILE setting in your shell overrides that default. --profile on a command overrides both.