Back to Medusa

{metadata.title}

www/apps/cloud/app/command-palette/page.mdx

2.14.25.4 KB
Original Source

import { getOsShortcut, Kbd, InlineIcon } from "docs-ui" import { ChevronRight } from "@medusajs/icons"

export const metadata = { title: Command Palette, }

{metadata.title}

In this guide, you'll learn how to use the command palette in Cloud to quickly perform actions and navigate to pages.

Open the Command Palette

Press <Kbd>{getOsShortcut()}</Kbd> + <Kbd>K</Kbd> to open the command palette from anywhere in the Cloud dashboard.

To close the palette, press <Kbd>Esc</Kbd> or click anywhere outside it.


Aside from clicking items with your mouse, you can navigate the command palette using your keyboard:

  • <Kbd></Kbd> / <Kbd></Kbd>: Move between items.
  • <Kbd></Kbd> (Enter): Select the highlighted item.
  • <Kbd>Esc</Kbd>: Close the palette.

Available Commands

The command palette organizes its commands into three types: Actions, Navigation, and Settings.

Actions

Actions let you perform tasks directly without navigating to a specific page first:

For the commands that perform actions on a specific project, such as Edit Variables or View Logs, you'll need to select a project after choosing the command.

Navigation items take you directly to a specific page in the Cloud dashboard:

For the commands that navigate to a specific project, such as Project Overview or Logs, you'll need to select a project after choosing the command.

Settings

Settings items take you to specific settings pages in the Cloud dashboard:

  • Organization Settings: Go to your organization's settings page.
  • Team Members: Go to the team members settings of your organization.
  • Usage: Go to the usage page for your organization to view your current usage and limits.
  • Email Activity: Go to the email activity page to monitor your outbound email sending activity.
  • Sender Domains: Go to the sender domains settings to manage your email sender domains.

Select a Specific Project

Some commands require you to choose a project before continuing. These commands display a <InlineIcon Icon={ChevronRight} alt="arrow" /> icon on the right side.

When you select one of these commands, the palette switches to a project-picker view:

  1. Open the command palette with <Kbd>{getOsShortcut()}</Kbd> + <Kbd>K</Kbd>.
  2. Select a command that shows a <InlineIcon Icon={ChevronRight} alt="arrow" /> icon, such as Project Overview.
  3. The palette displays a "Select a project..." search field and a list of your projects.
  4. Select a project from the list. You can search for a project by typing its name, and use <Kbd></Kbd> / <Kbd></Kbd> to move between projects.

The selected project's page opens immediately.

To go back to the main command list without selecting a project, click the badge (for example, the Project Overview badge) at the top of the palette.


Search for a Project

You can type in the command palette's search bar to filter both commands and project names.

To search for a project and navigate to its dashboard:

  1. Open the command palette with <Kbd>{getOsShortcut()}</Kbd> + <Kbd>K</Kbd>.
  2. Type the name of the project in the search bar.
  3. Select the matching project from the results.

This takes you directly to that project's dashboard.