Before you begin, an admin or owner on your workspace needs to have accepted the Slack Platform and Beta Service Terms here.
Automated installer for Mac and Linux
The automated installer script currently only supports Mac and Linux environments. If you are on Windows, please follow the steps in the Manual Installation tab.
Run the automated installer from your terminal window:
curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash
This will install the Slack CLI and all required dependencies, including Deno. You will also have the option to download the VSCode extension for Deno.
$ deno --version
deno 1.22.* (release, x86_64-apple-darwin)
v8 10.*
typescript 4.*
slack is installed and in your path:$ slack version
Using slack v1.8.1
$ slack doctor
Run the following command to authorize your CLI to your workspace:
$ slack login
Your terminal window will output a string that looks like this:
/slackauthticket ABC123defABC123defABC123defABC123defXYZ
Copy that whole string and paste it into any Slack channel or DM in the workspace you will be developing in. This activates a shortcut that will prompt you to approve access to the CLI.
After you approve access, you can verify that your CLI is setup and ready to go by running slack auth list in your terminal window:
$ slack auth list
[ACTIVE] myworkspace (Team ID: T1TK12345)
User ID: U1234567
Last update: 2022-05-24 12:00:00 Z
To change your active workspace authorization run slack login
$
You are ready to create your first Slack app on our next generation platform when you see your workspace in the output of slack auth list with an ACTIVE label.
Create a new Slack app with the command slack create <your-app-name>, which will give you a list of project templates to choose from:
$ slack create my-app
? Select a template to build from:
> Reverse string
A single function that reverses a string
Blank starter project
A, well.. blank project
The "Reverse string" template is a good example of a small app that does one thing: provides a single global shortcut that reverses a string. Alternatively, consider using the "Blank" template if you don't want any starter code.
While building your app, you can see your changes propagated to your workspace in real-time by running slack run.
Executing slack run starts a local development server, syncing changes to your workspace's development version of your app. (You'll know it's the development version because the name has the string (dev) appended).
Execute the Reverse shortcut by clicking on the Shortcuts icon and searching for the word reverse. Click on your shortcut when you see it, then supply a string in the modal that appears. Your shortcut's results will appear in the modal.
When you want to turn off the local development server, use Ctrl+c in the command prompt.
At this point your CLI is fully authorized and ready to create new projects.
✨ The next step on your journey is to create a new app!