chaarDocsDownloadConsole

Install

Install on a server

Add a server, a cloud VM or a spare computer as a machine, so your devices can open sessions on it.

You run every command on this page on the machine you're adding, usually over SSH.

What you need

  • An account. If you don't have one yet, follow the Quick start first.
  • Linux: x64 or arm64, on a distribution that uses systemd, such as Ubuntu or Debian. Distributions built on musl, such as Alpine, aren't supported.
  • macOS: Apple silicon. On a Mac you reach over SSH, your user has to be logged in on the Mac itself, because chaar starts when you log in.

Windows can't be added as a machine.

Add the machine

  1. Install the chaar command

    Run one of these on the machine:

    install script
    $ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/sixtythreelabs/chaar-releases/releases/download/cli/v0.1.0-alpha.3/chaar-installer.sh | sh
    or
    Homebrew
    $ brew install sixtythreelabs/tap/chaar
  2. Sign the machine in

    Terminal
    $ chaar service enable
    1. It asks Is this a headless machine (no browser)?. Press enter for yes, and it prints a link.
    2. Open the link on your laptop or phone, and sign in if asked.
    3. Type a Machine name, such as build-server, pick one or more workspaces under Workspace, and choose Register machine. If this machine was registered before, choose Authenticate machine instead.
    4. Back on the machine, type your password if asked. It says the service is enabled.

    Do step 3 within a minute. If the machine prints machine authorization timed out, run chaar service enable again.

  3. Check it's running

    Terminal
    $ chaar service status

    It says chaar service is enabled.

  4. Open it

    The machine now shows up on your laptop and phone, in the workspace you picked. Open a session on it as in the Quick start.

On Linux, chaar starts whenever the machine starts, even when nobody is logged in.

Update

chaar doesn't update itself. Update all your computers, servers and phones together: see A device says chaar needs updating for why.

  1. Update the command the way you installed it. With Homebrew, run brew upgrade sixtythreelabs/tap/chaar. With the install script, run it again.

  2. Restart chaar's service, so it runs the new version:

    Terminal
    chaar service disable
    chaar service enable

Restarting the service ends any agent chats running on this machine.

Remove chaar from the machine

Terminal
$ chaar service uninstall

This stops chaar on the machine and deletes its sign-in and agent chats there. It doesn't ask first. The machine still shows in your workspace until you remove it in the console: see Rename or remove a machine.

To stop chaar for a while instead, run chaar service disable. chaar service enable turns it back on.

Stuck? Ask in the Discord community.

↑↓Move↩Open