What can you do with Remote CLI?

Remote CLI provides terminal commands for supported Remote tasks. Available commands depend on the version you installed, the company you selected, and your Remote role and permissions.

If you are new to the CLI, follow the Remote CLI quick start to install it and complete the initial setup.

Review Remote information

Depending on your permissions, you can use supported commands to review information such as:

• Employments and contracts
• Contract amendments
• Departments and custom fields
• Expenses and expense categories
• Time off records, balances, and policies
• Onboarding steps
• Terminations
• Payslips
• Webhook activity

For example, remote employments list lists employments for the active company, and remote expenses list lists expenses for the active company.

Create or update Remote information

The CLI also includes commands that can change data. Depending on your permissions, supported actions include:

• Creating or updating employments
• Creating contract amendments
• Creating departments and custom fields
• Creating, approving, or declining expenses
• Creating, approving, declining, or canceling time off
• Canceling onboarding in supported circumstances
• Submitting termination requests
• Creating or managing webhooks

Review a command before you run it, especially when it creates, updates, approves, declines, cancels, or deletes information.

Check the commands available to you

Run remote --help to view the command areas available in your installed version. You can also run remote <command> --help to view guidance for a specific command.

If a command is unavailable

A command may be unavailable because:

• Your installed CLI version does not include it
• The command syntax is incorrect
• Your Remote role does not permit the action
• You selected the wrong company or account

If the CLI returns an unauthorized error, check your role and permissions. If it returns a different error, review the command reference and troubleshooting guidance.

Related articles

• See also: Getting started with Remote CLI
• See also: How does Remote CLI authentication and access work?
• See also: How do you troubleshoot Remote CLI?