Skip to content
Last updated

Search Redocly platform

Plans:ProScaleEnterprise

Search finds a setting, a page, a project, or an action by name, so you don't need to know which menu holds it.

Use either of these from any page in the Redocly platform:

  • Select Search at the top of the sidebar.
  • Press ⌘ Cmd + K on macOS, or Ctrl + K on Windows and Linux.

While the cursor is in the code editor, the shortcut keeps its editor action. Select Search in the sidebar to search from the editor.

Before you type, search lists recently opened pages and suggested actions.

Find something

  1. Open search.
  2. Type the start of a word, for example acc for Access and Account, or domain for Custom domain.
  3. Use the arrow keys to select a result, and press Enter to open it.

Each word you type matches the start of a word in a result's name, the place it lives, or in other names people use for it. For example, token finds API keys.

If no result matches your query, the page says so. Try a different query.

To close search, press Esc.

What search finds

Search groups the results by where they live:

GroupWhat it findsExample
ProjectsThe projects of the organizationType part of a project name to open that project
Project pagesPages of a project, such as Editor, Pull requests, and Deploymentsdeploy opens Deployments
Project settingsSettings of a projectbranch opens Branches & Deployments
Organization settingsOrganization settings, such as General, Billing, People, Teams, SSO and login, and API keysteams opens Teams, where you give a team access to a project
Your accountYour account settings: Account, Notifications, Appearance, Connections, and Invitationsnotif opens your notification settings
OrganizationsYour other organizationsType part of an organization name to switch to it
ActionsCommon tasks, such as Create project, Invite members, Add custom domain, Add API key, and Switch to dark themeinvite opens the form to invite people to the organization

Results depend on where you are. On a project page, search includes that project's pages and settings. On an organization page, search includes the pages and settings of every project you can open, with the project name next to each result. Add a word of the project name to narrow the results, for example cafe deploy for the Deployments page of the Cafe project.

Search displays only the pages and actions your role and plan let you use.

ActionmacOSWindows and Linux
Open search⌘ Cmd + KCtrl + K
Move between results↑ or ↓↑ or ↓
Open the selected resultEnterEnter
Close searchEscEsc

Resources

  • Keyboard shortcuts - Every shortcut you can use in the Redocly platform's editor
  • Teams - Give people access to projects through teams
  • Manage organizations - Change the settings that apply to every project in your organization