Create customizable link, clipboard, or cloud commands to use in the AI Command Bar.
What you'll need
- Custom commands are available on all ClickUp plans.
- Guests can't create custom commands.
- Members and above can create private custom commands.
- Admins and owners can share their custom commands with their Workspace.
Link commands
Open a link to a URL. For example: Open your Company Handbook.
Clipboard commands
Copy and paste content using the clipboard actions:
- Copy Text to Clipboard: Copy the same text to the Clipboard to paste it anywhere. For example: copy the link to schedule a meeting.
- Paste Text to Active App: On the desktop app, use this command to paste text wherever your cursor is located.
Cloud commands
Build fully customizable and interactive cloud commands.
Cloud commands are hosted at URL endpoints. The AI Command Bar makes HTTPS requests to the endpoint and interprets the JSON-encoded command response.
Commands that run in the cloud can't make any changes to your computer.
Developing & Deploying with Replit
The fastest way to host and develop cloud commands is with Replit, because you can use any programming language to write the command and do the development in the browser.
Fork Example
The fastest way to start is to fork another Repl.
Run Command
After forking the Repl, click the Run button to make sure the associated HTTPS endpoint is accessible.
The endpoint URL is located in the upper-right panel. This is the URL you will use to create the command inside the AI Command Bar.
Deploying & Sharing Command
By default, Repls aren't always running. If you plan to use the command often or to share it with others, make sure the Repl is set to be always on.
Deploying with Vercel
You can also use Vercel to deploy a command as a Serverless Function:
- Create a New Project inside Vercel using the NextJS template.
- Create a new file in the project under pages/api/ahoy-world.js.
- Add the following sample code and push to your repository to deploy it.
module.exports = async (req, res) => {
const response = {
view: {
type: "list",
options: [
{
title: "Open ClickUp",
action: {
type: "open-url",
url: "https://clickup.com"
}
},
{
title: "Copy Heart Emoji",
action: {
type: "copy",
value: "❤️"
}
}
]
}
};
res.setHeader("Access-Control-Allow-Headers", "*"); // for config headers
res.setHeader("Access-Control-Allow-Origin", "*");
res.json(response);
}Now you have a functioning URL that you can use to create a command!
Create a custom command
To create a custom command:
- Open the AI Command Bar.
- In the lower-right corner, click Settings.
- Select Search Settings.
- In the sidebar, click Commands.
- Click Add command or select a type of command to create.
- Add the required information and click Create Command.
When creating commands, we recommend using a naming convention that matches built-in ClickUp commands. A good format for a command is a verb, followed by a noun, written in titlecase.
For example: Open Company Handbook, Show Oncall Schedule, Search Customers.
Use a custom command in the AI Command Bar
To use a custom command:
- Type the command into the AI Command Bar.
- Matching results automatically display.
- Click the command, or hover over it and press
Returnon Mac orEnteron Windows.
Share a custom command
Admins and owners can share their custom commands with the Workspace.
To share a command:
- Open the AI Command Bar.
- In the lower-right corner, click Settings.
- Select Search Settings.
- In the sidebar, click Commands.
- To the right of the command under the Shared with column, click Private.
- Select Workspace.
Edit a custom command
To edit a command:
- Open the AI Command Bar.
- In the lower-right corner, click Settings.
- Select Search Settings.
- In the sidebar, click Commands.
- To the right of a command, click the ellipsis ... icon.
- Select Edit command.
- Update the command and click Save.
Delete a custom command
To delete a command:
- Open the AI Command Bar.
- In the lower-right corner, click Settings.
- Select Search Settings.
- In the sidebar, click Commands.
- To the right of a command, click the ellipsis ... icon.
-
Select Remove command.
Deleted commands cannot be recovered.
- Click Ok to confirm.