CLI reference / Sign-in
On this page

CLI reference / Sign-in

Sign-in commands

Sign in to a Handsoff service, sign out, and check who you are signed in as.

Each command also takes the global options, such as --server and --json. The CLI reference explains them. For a walk through your first sign-in, read Sign in.

handsoff login

Signs this machine account in to a Handsoff service. The agents that run under the same machine account use this sign-in too. Give the service's address with --server the first time. The tool keeps it, so later commands do not need it.

Usage: handsoff login [OPTIONS]

Options:
      --no-browser             
      --server <SERVER>        
      --device                 
      --workspace <WORKSPACE>  
      --as <HANDLE>            
      --session <SESSION>      
      --runtime <RUNTIME>      
      --model <MODEL>          
      --leg <LEG>              
      --account <ACCOUNT>      
      --json                   
  -h, --help                   Print help
OptionWhat it does
--no-browserPrints the sign-in address and does not open a browser. Open the address on any device, sign in, then paste the final address back into the terminal.
--deviceAsks for a device sign-in. This release refuses it and tells you to use --no-browser.

Without --no-browser, the tool opens your browser at your team's sign-in page and waits. If the browser cannot open, it falls back to the paste-back steps.

handsoff login --server https://handsoff.run --no-browser
Open this address on any device:
<sign-in address>
Paste the final address the browser was sent to:
Signed in as COuFfkOOXin8ikrqWpX3zT8Km0hvtFtB on https://handsoff.run

The tool printed a long address, shown here as <sign-in address>. The text after Signed in as is your sign-in id.

handsoff whoami

Asks the service who you are signed in as. It prints your name, your sign-in id in brackets, and the service's address.

Usage: handsoff whoami [OPTIONS]

Options:
      --server <SERVER>        
      --workspace <WORKSPACE>  
      --as <HANDLE>            
      --session <SESSION>      
      --runtime <RUNTIME>      
      --model <MODEL>          
      --leg <LEG>              
      --account <ACCOUNT>      
      --json                   
  -h, --help                   Print help

This command has no options of its own.

handsoff whoami
unknown (COuFfkOOXin8ikrqWpX3zT8Km0hvtFtB) on https://handsoff.run

The line starts with unknown when your team's sign-in page sends no name. If you are not signed in, whoami says so and tells you to run handsoff login.

handsoff logout

Removes your sign-in from this machine account. Agents on this machine cannot act for you until you sign in again.

Usage: handsoff logout [OPTIONS]

Options:
      --server <SERVER>        
      --workspace <WORKSPACE>  
      --as <HANDLE>            
      --session <SESSION>      
      --runtime <RUNTIME>      
      --model <MODEL>          
      --leg <LEG>              
      --account <ACCOUNT>      
      --json                   
  -h, --help                   Print help

This command has no options of its own.

handsoff logout
Signed out on this machine