CLI installation and usage

This guide covers installing Remy CLI on macOS, signing in, running tasks in local projects, resuming chats, updating the CLI, and sending feedback.

flowchart LR
    A["Set up Node.js and npm"] --> B["Install Remy CLI"]
    B --> C["Sign in"]
    C --> D["Go to your project"]
    D --> E["Start a task"]
    E --> F["Review and continue"]

1. Before you start

1.1 System and runtime requirements

The CLI requires Node.js and npm. The standard npm installation of Remy CLI does not require a separate Python or Rust installation. Your project and its tests still need their own environment and dependencies.

Check your setup in the terminal:

node --version
npm --version

Both commands should print a version number. If either command is missing, get the appropriate Mac installer from the Node.js website, finish installation, and open a new terminal. Choose the current LTS release before installing Remy.

1.2 Model access

Sign in with your Remy account to use the models available to it. The standard workflow does not require a separate model-provider account or API key.

Sign in to the desktop app and CLI separately. Even if you’re signed in to Remy Desktop, you still need to sign in the first time you use the CLI.

2. Install and check the CLI

2.1 Install Remy CLI

Run this in your terminal:

npm install -g @corepassinc/remy

Wait for installation to finish. The installer selects components for your operating system and the architecture of your Node.js runtime. You don’t need to choose a separate Apple silicon or Intel CLI package.

2.2 Check that the command is available

After installation, run:

remy --version
remy --help

If your terminal can’t find remy, open a new terminal and check the installation and command-path guidance in section 7.

3. Sign in and check your account

3.1 Sign in

Run this in your terminal:

remy login

1. Complete sign-in in the browser that opens.
2. Return to the terminal and wait for the result.
3. When you see Signed in as …, continue to the next step.

If sign-in fails, follow the terminal’s message to check your connection or start sign-in again.

3.2 Check the active account

remy whoami

Use this command to check the signed-in account, its current account scope, and the working directory. If you use a team account, confirm that the intended team is selected.

3.3 Check the runtime

remy doctor

Use the results to decide what needs attention:

Passing runtime checks does not verify a complete task. Run a real task to confirm that model access, project access, and results work as expected.

To sign out of the CLI:

remy logout

4. Start an interactive task in your project

4.1 Go to your project folder

In your terminal, go to the project you want to work on, then start Remy:

cd "/path/to/project"
remy

Replace /path/to/project with your actual local project path.

You can also specify the project folder when starting Remy:

remy --workspace "/path/to/project"

Check the folder before you start. The CLI works from the current working directory. To work on another project, exit the interactive session, then go to the other folder or start Remy with --workspace.

4.2 Choose a model and send a task

In the Remy interactive interface:

1. Press F2 or enter /model to see the available models.
2. Choose a model. For models with reasoning settings, use Ctrl+U to adjust them.
3. Describe your task in the input area and press Enter to send it.

In a macOS terminal, Option+Enter adds a new line. Press Ctrl+G to see keyboard shortcuts and available options.

Choose a model before starting the task. The list shown in the CLI reflects the models available to your current account.

4.3 Make a small change

Choose a real issue in an existing project. The example below uses filtering and pagination in an order list; adapt the feature and behavior to your own project.

First, understand the relevant code:

Read this project’s documentation and relevant instructions.
Identify the files, filtering logic, pagination logic, and tests for the order list.

Analyze only. Do not edit files, install dependencies, commit, or push code.

Once you’ve checked that Remy understands the task, continue in the same chat:

When I change the status filter on page 3 of the order list, the list appears empty.
Results appear only after I return to page 1.

Find and fix the issue so that changing the filter resets the page number.
Change only the relevant logic, and add and run relevant tests.
When finished, summarize the files changed, check results, and any checks you could not complete.

Do not commit or push code yet.

If Remy asks for more information or confirmation, read the request before responding. Use /permissions to view the current chat’s action permissions and follow the interface prompts to choose a setting.

4.4 Review the results and continue

If your project uses Git, open another terminal window in the same project to inspect uncommitted changes:

git status --short
git diff

By default, git diff shows unstaged changes to tracked files. It does not show new file contents or staged changes. Use git diff --cached for staged changes, and open new files directly to inspect them. The changes you see may also include work that existed before the task started.

To refine the result, describe what happened, what you expected, and what should change in the original chat:

The page number now resets, but the list does not refresh.
It should request fresh data as soon as the filter changes.

Fix only this issue, add and run relevant tests,
and summarize the change and check results. Do not commit or push code yet.

4.5 Common keyboard shortcuts

5. Commands and continuing chats

5.1 Know where to enter a command

Run installation commands such as npm install in your system terminal, rather than sending them to Remy as task prompts.

5.2 Common interactive commands

Before starting a new chat or resuming one, finish the current task and check the files as they actually exist in your project.

5.3 List past chats

Run this in your system terminal:

remy history list

This lists chats for the current project within your active account scope. In the interactive interface, use /resume or Ctrl+R to choose a chat and continue it.

Which chats you can see depends on the signed-in account, team scope, and project folder. Access to local history does not mean every device is automatically synced.

5.4 Run a one-shot task

For a clear task that does not need an ongoing conversation, use:

remy exec "Read this project’s README and summarize how to run the project and its tests. Analyze only; do not edit files."

The command runs that task and prints the result. For work that needs follow-up instructions, start interactive mode with remy.

To provide local reference material, attach a file:

remy exec --attach "./requirements.md" "Read these requirements and identify the affected modules and implementation steps in this project. Do not edit files yet."

Replace the file path with a file that exists on your machine. For more options, run:

remy exec --help

6. Update Remy CLI

6.1 Check your version

remy --version

6.2 Update the default release

Finish the current task and leave the Remy interactive interface, then run:

npm install -g @corepassinc/remy

When installation finishes, check again:

remy --version
remy --help

If the CLI still reports an older version, check which command your terminal is finding:

command -v remy
npm prefix -g

If you use a Node.js version manager, each Node.js environment may have its own global installation directory. After switching environments, check the Remy installation and command path in the active environment.

7. Troubleshooting and known limitations

7.1 Installation and runtime issues

7.2 Scope and limitations

• This guide covers macOS on Apple silicon and Intel.
• Local tasks depend on your computer, terminal session, and project environment. Keep the required environment available.
• Tool access differs across clients. Optional CLI tools depend on the diagnostic results and actual configuration.
• The CLI does not currently support thumbs-up/down ratings for individual responses. Use the feedback command in the next section for product issues.
• Resuming a chat does not roll back files. Check the current file state before continuing.

8. Get help and send feedback

8.1 View command help

remy --help
remy doctor --help
remy feedback send --help

Inside Remy, use /help for commands and Ctrl+G for keyboard shortcuts.

8.2 Describe the issue

Save your issue description as a UTF-8 text file, such as feedback.txt. Include the steps to reproduce it, what you expected, what happened, and any error messages and version details.

8.3 Preview and submit

Preview your report first:

remy feedback send --type bug --impact moderate --description-file "./feedback.txt" --dry-run

--dry-run shows the preview without sending a report. After checking the description and feedback options, remove that flag and run the command again:

remy feedback send --type bug --impact moderate --description-file "./feedback.txt"

The CLI shows a preview, then asks you to type send to confirm. Enter something else to cancel.

Choose the type and impact that match your issue; the example’s bug and moderate values are only examples.

Treat the report as submitted only when the command explicitly confirms success and returns a feedback ID. Result unknown means the CLI did not receive a reliable submission result. Check with support before sending again to avoid a duplicate report.

If you can’t start the CLI, sign in, or use the feedback command, contact support at support@corepass.com.

8.4 Keep exploring