Global search
Port's global search provides a quick way to find entities, actions, blueprints, and more across your software catalog.
Accessing the search
You can access the global search in several ways:
- Keyboard shortcut: Press
Cmd + K(Mac) orWin + K(Windows). - Click: Click on the search bar in the top right corner of your portal.
The search opens an interface in the center of the page, displaying relevant results as you type.
Search results
The search displays the most relevant results in four categories:
- Entities: Entities whose properties (including title & identifier) match your search query. You can search for entities by their title, identifier, description, or any other property.
- Tech docs: Entities that have a
markdownproperty whose content contains your search query. - Actions: Actions whose title or identifier match your search query.
- Blueprints: Blueprints whose title or identifier match your search query.
Entity global search settings
Organization admins can control which blueprints' entities appear in global search results. This is useful for reducing noise when your catalog contains many blueprints.
To configure this:
- Navigate to the Builder page of your portal.
- Click on Organization settings in the left sidebar.
- Select the Search tab.
- Use the dropdown to choose a filtering mode:
- Exclude selected blueprints (default): All blueprints' entities are searchable, except for any you explicitly select to exclude. If no blueprints are selected, everything is searchable.
- Include selected blueprints: Only the blueprints you explicitly select will have their entities appear in search results.
- Use the multi-select field to pick the specific blueprints to include or exclude, based on the mode you selected.
- Click Save.
It is also possible to set the includeInGlobalSearch field directly in a blueprint's JSON definition when editing it in JSON mode. This value will override whatever is configured in the search tab of the organization settings. You can also define this via API and IaC (Terraform).
Port highlight search - chrome extension
This handy chrome extension allows you to highlight text in any webpage and quickly search for it in Port using the global search bar.