Skip to content

docs: tweaks formatting to match rest of docs #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lukegalbraithrussell merged 3 commits into from
Jul 11, 2025
Merged

docs: tweaks formatting to match rest of docs #150

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
93f01a7
docs: formatting
lukegalbraithrussell Jul 9, 2025
0e3e576
added a few more relative links
lukegalbraithrussell Jul 9, 2025
d4848a3
Merge branch 'main' into docs-formatting-cleanup
lukegalbraithrussell Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/guides/authorizing-the-slack-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ Setting up a CI/CD pipeline requires authorization using a service token. Servic

To get a service token, you'll use the `slack auth token` command to get a `slackauthticket`, which you'll copy and paste into your workspace to exchange for the service token. The service token will not be saved to your `credentials.json` file; instead, it is presented in the terminal for you to copy and paste for use in your CI/CD pipeline. Once copied, you'll use the `slack login --auth <your-service-token>` command to authorize your Slack CLI. Detailed instructions are below.

:::info
:::info[The service token will not conflict with your regular authentication token.]

The service token will not conflict with your regular authentication token; you can continue using your regular authentication token within the Slack CLI while using the service token for your CI/CD pipeline.
You can continue using your regular authentication token within the Slack CLI while using the service token for your CI/CD pipeline.

:::

Expand Down
25 changes: 12 additions & 13 deletions docs/guides/installing-the-slack-cli-for-mac-and-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ The Slack CLI is a set of tools critical to building workflow apps. This is your

⤵️ **If you need to authorize the Slack CLI, [go here](/slack-cli/guides/authorizing-the-slack-cli)**.

:::info
:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.]

The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`. If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version.
If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version.

:::

Expand Down Expand Up @@ -79,6 +79,7 @@ curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash -s -- -d
Error: _Failed to create a symbolic link! The installer doesn't have write access to /usr/local/bin. Please check permission and try again..._

Solution: Sudo actions within the scripts were removed so as not to create any security concerns. The `$HOME` env var is updated to `/root` &mdash; however, the installer is using `$HOME` for both Deno and the SDK install, which causes the whole install to be placed under `/root`, making both Deno and the SDK unusable for users without root permissions.

* For users who do not have root permissions, run the sudo actions manually as follows: `sudo mkdir -p -m 775 /usr/local/bin`, then `sudo ln -sf "$slack_cli_bin_path" "/usr/local/bin/$SLACK_CLI_NAME"` where `$slack_cli_bin_path` is typically `$HOME/.slack/bin/slack` and `$SLACK_CLI_NAME` is typically the alias (by default it’s `slack`).
* For users who do have root permissions, you can run the installation script as `sudo curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash`. In this case, the script is executed as root.

Expand All @@ -101,23 +102,22 @@ v8 10.*
typescript 4.*
```

**3\. Download and install
[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), a
dependency of the** `slack` **CLI.**
**3\. Download and install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), a dependency of the** `slack` **CLI.**

**4\. Download the** `slack` **CLI installer for your environment.**

<ts-icon class="ts_icon_apple"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_arm64.tar.gz"><strong>Download for macOS Apple Silicon (.tar.gz)</strong></a>
🍎 ⚡️ [**Download for macOS Apple Silicon (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_arm64.tar.gz)

<ts-icon class="ts_icon_apple"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_amd64.tar.gz"><strong>Download for macOS Intel (.tar.gz)</strong></a>
🍏 🪨 [**Download for macOS Intel (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_amd64.tar.gz)
Copy link
Contributor Author

@lukegalbraithrussell lukegalbraithrussell Jul 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stone because rosetta, get itttttt

Copy link
Member

@mwbrooks mwbrooks Jul 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😄 And the green apple 🍏

Copy link
Member

@mwbrooks mwbrooks Jul 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could upload macOS, Windows, and Linux icons as well.


<ts-icon class="ts_icon_plug"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_linux_64-bit.tar.gz"><strong>Download for Linux (.tar.gz)</strong></a>
🐧 💾 [**Download for Linux (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_linux_64-bit.tar.gz)

**5\. Add the** `slack` **CLI to your path.**

:::info
<p><strong>Existing</strong> <code>slack</code> <strong>binary in path?</strong></p>
<p>If you have another CLI tool in your path called <code>slack</code>, we recommend renaming our slack binary to a different name before adding it to your path. See the <strong>Automated installation</strong> tab for more details.</p>
:::info[Existing `slack` binary in path?]

If you have another CLI tool in your path called `slack`, we recommend renaming our slack binary to a different name before adding it to your path. See the **Automated installation** tab for more details.

:::

**6\. Verify that** `slack` **is installed and in your path.**
Expand Down Expand Up @@ -165,8 +165,7 @@ In addition, if you attempt to run the `slack run` command without this dependen

Ensure that `deno-slack-hooks` is installed at the project level and that the version is not less than `v1.3.0`.

**8\. [Install the VSCode extension for
Deno](/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**
**8\. [Install the VSCode extension for Deno](/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**
Copy link
Member

@mwbrooks mwbrooks Jul 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: Soon, it may make sense to have the Deno install instructions on the Deno SDK page and link to it (and Bolt JS/Python) from here.


</TabItem>
</Tabs>
32 changes: 10 additions & 22 deletions docs/guides/installing-the-slack-cli-for-windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,13 @@ The Slack CLI is a set of tools critical to building workflow apps. This is your

⤵️ **If you need to authorize the Slack CLI, [go here](/slack-cli/guides/authorizing-the-slack-cli)**.

:::info
:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.]

The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`. If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version.
If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version.

:::

:::warning

**PowerShell is required for installing the Slack CLI on Windows machines.** An alternative shell will not work.
:::warning[PowerShell is required for installing the Slack CLI on Windows machines; an alternative shell will not work.]

:::

Expand All @@ -33,17 +31,11 @@ The minimum required Slack CLI version for Enterprise Grid as of September 19th,
irm https://downloads.slack-edge.com/slack-cli/install-windows.ps1 | iex
```

:::warning

PowerShell is required for installing the Slack CLI on Windows machines; an alternative shell will not work.
:::warning[PowerShell is required for installing the Slack CLI on Windows machines; an alternative shell will not work.]

:::

This will install the Slack CLI and all required dependencies, including [Deno](/deno-slack-sdk/guides/installing-deno),
the runtime environment for workflow apps. If you have VSCode installed,
the [VSCode Deno
extension](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno)
will be installed.
This will install the Slack CLI and all required dependencies, including [Deno](/deno-slack-sdk/guides/installing-deno), the runtime environment for workflow apps. If you have VSCode installed, the [VSCode Deno extension](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno) will be installed.

<details>
<summary>Optional: Use an alias for the Slack CLI binary</summary>
Expand All @@ -63,9 +55,7 @@ You can also use the `-Alias` flag as described within **Optional: customize ins
<details>
<summary>Optional: customize installation using flags</summary>

There are several flags available to customize the installation. Since flags
cannot be passed to remote scripts, you must first download the installation
script to a local file:
There are several flags available to customize the installation. Since flags cannot be passed to remote scripts, you must first download the installation script to a local file:

```zsh
irm https://downloads.slack-edge.com/slack-cli/install-windows.ps1 -outfile 'install-windows.ps1'
Expand Down Expand Up @@ -123,19 +113,17 @@ v8 10.*
typescript 4.*
```

**3\. Download and install
[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), a
dependency of the** `slack` **CLI.**
**3\. Download and install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), a dependency of the** `slack` **CLI.**

**4\. Download the** `slack` **CLI installer for your environment.**

<ts-icon class="ts_icon_windows"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_windows_64-bit.zip"><strong>Windows (.zip)</strong></a>

**5\. Add the** `slack` **CLI to your path.**

:::info
<p><strong>Existing</strong> <code>slack</code> <strong>binary in path?</strong></p>
<p>If you have another CLI tool in your path called <code>slack</code>, we recommend renaming our slack binary to a different name before adding it to your path. See the <strong>Automated installation</strong> tab for more details.</p>
:::info[Existing `slack` binary in path?]

If you have another CLI tool in your path called `slack`, we recommend renaming our slack binary to a different name before adding it to your path. See the **Automated installation** tab for more details.

:::

Expand Down
4 changes: 1 addition & 3 deletions docs/guides/running-slack-cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ slug: /slack-cli/guides/running-slack-cli-commands

The Slack CLI allows you to interact with your apps via the command line. Using the main command `slack`, you can create, run, and deploy apps, as well as create triggers and query datastores.

:::info

Running `slack help` will display available commands in your terminal window.
:::info[Running `slack help` will display available commands in your terminal window.]

:::

Expand Down
4 changes: 1 addition & 3 deletions docs/guides/setting-up-ci-cd-with-the-slack-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,7 @@ This also includes calling Deno's [task runner](https://deno.land/manual/tools/t

✨ **For more information about creating unit tests**, refer to [Testing custom functions](/deno-slack-sdk/guides/creating-custom-functions#testing).

:::info

If you've created your project by [cloning one of our sample apps](/deno-slack-sdk/guides/creating-an-app), note that the `.github` folder will not be included. You'll need to create it yourself, but you can use the handy dandy **Copy** button next to the code samples on this page to get started!
:::info[If you've created your project by [cloning one of our sample apps](/deno-slack-sdk/guides/creating-an-app), note that the `.github` folder will not be included. You'll need to create it yourself, but you can use the handy dandy **Copy** button next to the code samples on this page to get started!]

:::

Expand Down
4 changes: 1 addition & 3 deletions docs/guides/uninstalling-the-slack-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@ rd -r $HOME\AppData\Local\slack-cli

where `$HOME` is substituted for the full path, e.g. `C:\Users\<your_username>`.

:::warning

**As with installation, PowerShell is required for uninstallation of the Slack CLI from Windows machines.** An alternative shell will not work.
:::warning[As with installation, PowerShell is required for uninstallation of the Slack CLI from Windows machines; an alternative shell will not work.]

:::

Expand Down
10 changes: 5 additions & 5 deletions docs/guides/using-slack-cli-with-bolt-frameworks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ sidebar_label: Using with Bolt frameworks

# Using the Slack CLI with Bolt frameworks

You can use the Slack CLI to streamline development of apps using [Bolt for JavaScript](/tools.slack.dev/bolt-js) and [Bolt for Python](/tools.slack.dev/bolt-python).
You can use the Slack CLI to streamline development of apps using [Bolt for JavaScript](https://tools.slack.dev/bolt-js) and [Bolt for Python](/https://tools.slack.dev/bolt-python).

:::info
:::info[Feeling adventurous?]

To create a Bolt app using features currently under development, refer to the [experiments](https://tools.slack.dev/slack-cli/reference/experiments) page.
To create a Bolt app using features currently under development, refer to the [experiments](/slack-cli/reference/experiments) page.

:::

Expand All @@ -34,9 +34,9 @@ You will then be prompted to choose between **Bolt for JavaScript** or **Bolt fo

Your app will be cloned from the respective [JavaScript](https://github.com/slack-samples/bolt-js-starter-template) or [Python](https://github.com/slack-samples/bolt-python-starter-template) project template on our Slack Platform Sample Code repository, and its project dependencies will be installed. Then, `cd` into your project folder.

:::info
:::info[For Bolt for Python projects, automatic project dependency installation is currently unsupported, and will need to be done manually.]

For Bolt for Python projects, automatic project dependency installation is currently unsupported, and will need to be done manually. For more information, refer to [Getting started with Bolt for Python](https://tools.slack.dev/bolt-python/getting-started).
For more information, refer to [Getting started with Bolt for Python](https://tools.slack.dev/bolt-python/getting-started).

:::

Expand Down
Loading