The package.json manifest file is a superset of npm's package.json file. This way you only need one file to configure your extension. This document covers only the Raycast specific fields. Refer to npm's documentation for everything else.
Here is a typical manifest file:
1
{
2
"name":"my-extension",
3
"title":"My Extension",
4
"description":"My extension that can do a lot of things",
5
"icon":"icon.png",
6
"author":"thomas",
7
"license":"MIT",
8
"commands":[
9
{
10
"name":"index",
11
"title":"Send Love",
12
"description":"A command to send love to each other",
13
"mode":"view"
14
}
15
]
16
}
Copied!
Extension properties
All Raycast related properties for an extension.
Property
Description
name
A unique name for the extension. This is used in the Store link to your extension, so keep it short and URL compatible.
title
The title of the extension that is shown to the user in the Store as well as the preferences. Use this title to describe your extension well that users can find it in the Store.
description
The full description of the extension shown in the Store.
icon
A reference to an icon file in the assets folder. Use png format with a size of at least 512 x 512 pixels. To support light and dark theme, add two icons, one with @dark as suffix, e.g. icon.png and [email protected].
author
Your Raycast store handle (username)
keywords
An optional array of keywords for which the extension can be searched for in Raycast.
Extensions can contribute preferences that are shown in Raycast Preferences > Extensions. You can use preferences for configuration values and passwords or personal access tokens, see Preference Properties.
external
Optional array of package or file names that should be excluded from the build. The package will not be bundled but the import is preserved and will be evaluated at runtime.
Command properties
All properties for a command.
Property
Description
name
A unique name for the command. The name directly maps to the entry point file for the command. So a command named "index" would map to index.ts (or any other supported TypeScript or JavaScript file extension such as .tsx, .js, .jsx).
title
The display name of the command, shown to the user in Raycast.
subtitle
The optional subtitle of the command in the root search. Usually this is the service or domain that your command is associated with.
description
The full description of the command shown in the Raycast store.
icon
An optional reference to an icon file in the assets folder. Use png format with a size of at least 512 x 512 pixels. To support light and dark theme, add two icons, one with @dark as suffix, e.g. icon.png and [email protected].
​
If no icon is specified, the extension icon will be used.
mode
A value of view indicates that the command will show a main view when performed. no-view means that the command does not push a view to the main navigation stack in Raycast. Latter is handy for directly opening URL or other API functionality that doesn't require a user interface.
keywords
An optional array of keywords for which the command can be searched in Raycast.
preferences
Commands can optionally contribute preferences that are shown in Raycast Preferences > Extensions when selecting the command. You can use preferences for configuration values and passwords or personal access tokens, see Preference Properties. Commands automatically "inherit" extension preferences and can also override entries with the same name.
Preference properties
All properties for extension or command specific preferences. Also see the Preferences API Reference for more details.
Property
Description
name
A unique name for the preference.
type
The preference type. Currently we support type "textfield" and "password" (for secure entry), "checkbox", and "dropdown".
required
Indicates whether the value is required and must be entered by the user before the extension is usable.
title
The display name of the preference, shown to the user in Raycast preferences.
description
The full description of the preference, shown as tooltip for the field.
placeholder
The optional placeholder text shown in the preference field.
default
The optional default value for the field. For textfields, this is a string value; for checkboxes a boolean; for dropdowns the value of the selected item.
data
Optional, dropdowns only: An array of objects with title and value properties, e.g.: [{"title": "Item 1", value: "1"}]
label
Optional, checkboxes only: The label of the checkbox. If you want to group multiple checkboxes into a section, set the title of the first checkbox and leave the title of the other checkboxes empty but specify their label.