The Remote Command Line Interface (CLI) lets customers work with Remote from a terminal. You can use text commands for supported, repeatable tasks without opening the Remote dashboard or writing code to call the Remote application programming interface (API).
The CLI is designed for customers who are comfortable using a terminal, including People Operations, Payroll, Finance, and IT administrators. It is not intended for general end-user tasks. Most customers can continue using the Remote dashboard.
Before you start
You need:
- A Remote account with permission to perform the tasks you want to complete
- Access to a supported terminal
- Comfort entering commands and reading command output
- Review the installation and setup requirements in the Remote CLI quick start guide
Set up the Remote CLI
- Install the Remote CLI by following the quick start instructions.
- Open your terminal.
- Run
remotecli loginto start browser-based sign-in. - Approve access in the browser window that opens.
- If you work with more than one company, run
remotecli useto select the company you want to work with. - Run
remotecli --helpto view available commands. - If you plan to use the CLI with Claude Code or OpenAI Codex in your terminal, we recommend installing the agent skills. Run
remotecli skills install.
The actions available to you depend on your Remote role and permissions. If your role does not allow an action, the CLI returns an Unauthorized error.
Choose the right Remote tool
| Tool | Use it for | Examples |
|---|---|---|
| Remote dashboard | Visual, everyday work | Review team information or download a report |
| Remote CLI | Narrow, repeatable tasks from a terminal | List employments or approve a pending expense, if permitted |
| Remote API | Durable integrations and long-term data synchronization | Connect Remote to an HR information system or accounting platform |
| Remote Model Context Protocol (MCP) | Accessing Remote through an artificial intelligence assistant | Let an approved AI assistant retrieve or act on Remote data |
Use the CLI when you want to access supported Remote API capabilities from a terminal without writing code. Use the Remote API for production integrations and long-term system connections.
Find available commands
Run remotecli --help for the commands available in your installed version. For the complete and current command reference, see the Remote CLI developer documentation.
Related articles
- See also: How does Remote CLI authentication and access work?
- See also: What can you do with Remote CLI?
- See also: How do you troubleshoot Remote CLI?
Comments
0 comments
Please sign in to leave a comment.