Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ submit an issue or pull request to start a discussion!

Thanks for stopping by! You're awesome :sunglasses:

[commands]: https://tools.slack.dev/slack-cli/reference/commands/slack
[commands]: https://docs.slack.dev/tools/slack-cli/reference/commands/slack
[dev]: https://github.com/slackapi/slack-cli/releases/tag/dev-build
[enhancements]: https://github.com/slackapi/slack-cli/pulls
[install]: https://tools.slack.dev/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux
[install]: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux
[issues]: https://github.com/slackapi/slack-cli/issues/new?template=04_bug.md
[maintainers]: .github/MAINTAINERS_GUIDE.md
[releases]: https://github.com/slackapi/slack-cli/releases
Expand Down
30 changes: 15 additions & 15 deletions docs/_sidebar.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[
{
"type": "doc",
"id": "slack-cli/index",
"id": "tools/slack-cli/index",
"label": "Slack CLI",
"className": "sidebar-title"
},
Expand All @@ -11,17 +11,17 @@
"label": "Guides",
"collapsed": false,
"items": [
"slack-cli/guides/installing-the-slack-cli-for-mac-and-linux",
"slack-cli/guides/installing-the-slack-cli-for-windows",
"slack-cli/guides/authorizing-the-slack-cli",
"slack-cli/guides/using-slack-cli-with-bolt-frameworks",
"slack-cli/guides/using-slack-cli-on-an-enterprise-grid-organization",
"slack-cli/guides/running-slack-cli-commands",
"slack-cli/guides/using-environment-variables-with-the-slack-cli",
"slack-cli/guides/troubleshooting-slack-cli-errors",
"slack-cli/guides/setting-up-ci-cd-with-the-slack-cli",
"slack-cli/guides/deploying-with-the-slack-cli-and-github-actions",
"slack-cli/guides/uninstalling-the-slack-cli"
"tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux",
"tools/slack-cli/guides/installing-the-slack-cli-for-windows",
"tools/slack-cli/guides/authorizing-the-slack-cli",
"tools/slack-cli/guides/using-slack-cli-with-bolt-frameworks",
"tools/slack-cli/guides/using-slack-cli-on-an-enterprise-grid-organization",
"tools/slack-cli/guides/running-slack-cli-commands",
"tools/slack-cli/guides/using-environment-variables-with-the-slack-cli",
"tools/slack-cli/guides/troubleshooting-slack-cli-errors",
"tools/slack-cli/guides/setting-up-ci-cd-with-the-slack-cli",
"tools/slack-cli/guides/deploying-with-the-slack-cli-and-github-actions",
"tools/slack-cli/guides/uninstalling-the-slack-cli"
]
},
{ "type": "html", "value": "<hr>" },
Expand All @@ -36,18 +36,18 @@
"items": [
{
"type": "autogenerated",
"dirName": "slack-cli/reference/commands"
"dirName": "tools/slack-cli/reference/commands"
}
]
},
{
"type": "doc",
"id": "slack-cli/reference/errors",
"id": "tools/slack-cli/reference/errors",
"label": "Errors"
},
{
"type": "doc",
"id": "slack-cli/reference/experiments",
"id": "tools/slack-cli/reference/experiments",
"label": "Experiments"
}
]
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/authorizing-the-slack-cli.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
slug: /slack-cli/guides/authorizing-the-slack-cli
slug: /tools/slack-cli/guides/authorizing-the-slack-cli
---

# Authorizing the Slack CLI {#authorize-cli}

Once you have the Slack CLI installed for either [Windows](/slack-cli/guides/installing-the-slack-cli-for-windows) or [Mac/Linux](/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux), authorize the Slack CLI in your workspace with the following command:
Once you have the Slack CLI installed for either [Windows](/tools/slack-cli/guides/installing-the-slack-cli-for-windows) or [Mac/Linux](/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux), authorize the Slack CLI in your workspace with the following command:

```zsh
slack login
Expand Down
16 changes: 8 additions & 8 deletions docs/guides/deploying-with-the-slack-cli-and-github-actions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: Deploying with GitHub Actions
slug: /slack-cli/guides/deploying-the-slack-cli-with-github-actions
slug: /tools/slack-cli/guides/deploying-the-slack-cli-with-github-actions
---

# Deploying with the Slack CLI & GitHub Actions
Expand All @@ -10,26 +10,26 @@ This tutorial demonstrates how to use CI/CD to facilitate automatic deployments
Before we begin, you'll need to do the following:

* Create a new GitHub repository &mdash; any name will do.
* [Install](/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux) the Slack CLI on your machine.
* [Authorize](/slack-cli/guides/authorizing-the-slack-cli) the Slack CLI to your workspace.
* [Install](/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux) the Slack CLI on your machine.
* [Authorize](/tools/slack-cli/guides/authorizing-the-slack-cli) the Slack CLI to your workspace.

Once those steps have been completed, we're ready to move on to building our automated deployment app.

## Create a new app {#create}

Run `slack create` to create a new Slack app project. Select a template to build from; in this case, hit **Enter** to choose the default `Issue submission` template.

Refer to [Create or remove an app](/deno-slack-sdk/guides/creating-an-app) for more details.
Refer to [Create or remove an app](/tools/deno-slack-sdk/guides/creating-an-app) for more details.

## Initial deploy {#initial-deploy}

Run `slack deploy` to manually deploy the new app to your workspace for the first time. During the process, you'll be prompted to create a link trigger. Refer to [Link triggers](/deno-slack-sdk/guides/creating-link-triggers) for more details.
Run `slack deploy` to manually deploy the new app to your workspace for the first time. During the process, you'll be prompted to create a link trigger. Refer to [Link triggers](/tools/deno-slack-sdk/guides/creating-link-triggers) for more details.

Once created, copy the link and share it in a Slack channel. You'll see a button appear to start the workflow; click it to verify that the default workflow is functioning properly.

## Obtain a service token {#obtain-service-token}

To automate subsequent deployments, we'll need to obtain a [service token](/slack-cli/guides/authorizing-the-slack-cli#ci-cd) for the app.
To automate subsequent deployments, we'll need to obtain a [service token](/tools/slack-cli/guides/authorizing-the-slack-cli#ci-cd) for the app.

Navigate to the root directory of your project and run the `slack auth token` command. You'll be prompted to run a slash command called `slackauthticket`, similar to the way you authorized your app earlier. Copy that command and run it in Slack, then copy the challenge code you receive and enter it into your terminal. You'll see a service token that starts with `xoxp-` &mdash; make sure you save this token. Note that this token is connected to a specific workspace and organization.

Expand Down Expand Up @@ -92,6 +92,6 @@ Your GitHub repository is now set up for team collaboration! Your team members c

Check out these articles to expand your knowledge and skills of automated deployments and the Slack CLI:

➡️ [CI/CD overview and setup](/slack-cli/guides/setting-up-ci-cd-with-the-slack-cli)
➡️ [CI/CD overview and setup](/tools/slack-cli/guides/setting-up-ci-cd-with-the-slack-cli)

➡️ [CI/CD authorization](/slack-cli/guides/authorizing-the-slack-cli#ci-cd)
➡️ [CI/CD authorization](/tools/slack-cli/guides/authorizing-the-slack-cli#ci-cd)
12 changes: 6 additions & 6 deletions docs/guides/installing-the-slack-cli-for-mac-and-linux.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
sidebar_label: Installing for MacOS & Linux
slug: /slack-cli/guides/installing-the-slack-cli-for-mac-and-linux
slug: /tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux
---

# Installing the Slack CLI for Mac & Linux

The Slack CLI is a set of tools critical to building workflow apps. This is your one-stop shop for those tools.

✨ **If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance.
✨ **If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/tools/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance.

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

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

Expand All @@ -26,7 +26,7 @@ If you attempt to log in with an older version, you'll receive a `cli_update_req
curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash
```

This will install the Slack CLI and all required dependencies, including [Deno](/deno-slack-sdk/guides/installing-deno),
This will install the Slack CLI and all required dependencies, including [Deno](/tools/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)
Expand Down Expand Up @@ -92,7 +92,7 @@ Solution: Sudo actions within the scripts were removed so as not to create any s

Manual installation allows you to omit the Deno installation if you don't need it. Deno is needed if you are creating [workflow apps](https://docs.slack.dev/workflows). If you intend to solely use the CLI for Bolt apps, you do not need Deno. If you forgo the Deno installation, skip to step 3.

**1\. Download and install [Deno](https://deno.land).** Refer to [Install Deno](/deno-slack-sdk/guides/installing-deno) for more details.
**1\. Download and install [Deno](https://deno.land).** Refer to [Install Deno](/tools/deno-slack-sdk/guides/installing-deno) for more details.

**2\. Verify that Deno is installed and in your path.**

Expand Down Expand Up @@ -171,7 +171,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](/tools/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**

</TabItem>
</Tabs>
12 changes: 6 additions & 6 deletions docs/guides/installing-the-slack-cli-for-windows.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
sidebar_label: Installing for Windows
slug: /slack-cli/guides/installing-the-slack-cli-for-windows
slug: /tools/slack-cli/guides/installing-the-slack-cli-for-windows
---

# Installing the Slack CLI for Windows

The Slack CLI is a set of tools critical to building workflow apps. This is your one-stop shop for those tools.

✨ **If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance.
✨ **If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/tools/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance.

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

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

Expand All @@ -34,7 +34,7 @@ irm https://downloads.slack-edge.com/slack-cli/install-windows.ps1 | iex

:::

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](/tools/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 Down Expand Up @@ -99,7 +99,7 @@ Solution: For the installer to work correctly, your PowerShell session's [langua

Manual installation allows you to omit the Deno installation if you don't need it. Deno is needed if you are creating [workflow apps](https://docs.slack.dev/workflows). If you intend to solely use the CLI for Bolt apps, you do not need Deno. If you forgo the Deno installation, skip to step 3.

**1\. Download and install [Deno](https://deno.land).** Refer to [Install Deno](/deno-slack-sdk/guides/installing-deno) for more details.
**1\. Download and install [Deno](https://deno.land).** Refer to [Install Deno](/tools/deno-slack-sdk/guides/installing-deno) for more details.

**2\. Verify that Deno is installed and in your path.**

Expand Down Expand Up @@ -173,7 +173,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](/tools/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**

</TabItem>
</Tabs>
Expand Down
52 changes: 26 additions & 26 deletions docs/guides/running-slack-cli-commands.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: Running commands
slug: /slack-cli/guides/running-slack-cli-commands
slug: /tools/slack-cli/guides/running-slack-cli-commands
---

# Running Slack CLI commands
Expand Down Expand Up @@ -29,28 +29,28 @@ Below you'll find all the commands and subcommands for the Slack CLI. Each one h

| Command | Description |
| :--- | :--- |
| [`slack activity`](/slack-cli/reference/commands/slack_activity) | Display the app activity logs from the Slack Platform
| [`slack app`](/slack-cli/reference/commands/slack_app) | Install, uninstall, and list teams with the app installed
| [`slack auth`](/slack-cli/reference/commands/slack_auth) | Add and remove local team authorizations
| [`slack collaborator`](/slack-cli/reference/commands/slack_collaborator) | Manage app collaborators
| [`slack create`](/slack-cli/reference/commands/slack_create) | Create a Slack project
| [`slack datastore`](/slack-cli/reference/commands/slack_datastore) | Query an app's datastore
| [`slack delete`](/slack-cli/reference/commands/slack_delete) | Delete the app
| [`slack deploy`](/slack-cli/reference/commands/slack_deploy) | Deploy the app to the Slack Platform
| [`slack doctor`](/slack-cli/reference/commands/slack_doctor) | Check and report on system and app information
| [`slack env`](/slack-cli/reference/commands/slack_env) | Add, remove, and list environment variables
| [`slack external-auth`](/slack-cli/reference/commands/slack_external-auth) | Add and remove external authorizations and client secrets for providers in your app
| [`slack feedback`](/slack-cli/reference/commands/slack_feedback) | Share feedback about your experience or project
| [`slack function`](/slack-cli/reference/commands/slack_function) | Manage the functions of an app
| [`slack install`](/slack-cli/reference/commands/slack_install) | Install the app to a team
| [`slack list`](/slack-cli/reference/commands/slack_list) | List all authorized accounts
| [`slack login`](/slack-cli/reference/commands/slack_login) | Log in to a Slack account
| [`slack logout`](/slack-cli/reference/commands/slack_logout) | Log out of a team
| [`slack manifest`](/slack-cli/reference/commands/slack_manifest) | Print the app manifest of a project or app
| [`slack platform`](/slack-cli/reference/commands/slack_platform) | Deploy and run apps on the Slack Platform
| [`slack run`](/slack-cli/reference/commands/slack_run) | Start a local server to develop and run the app locally
| [`slack samples`](/slack-cli/reference/commands/slack_samples) | List available sample apps
| [`slack trigger`](/slack-cli/reference/commands/slack_trigger) | List details of existing triggers
| [`slack uninstall`](/slack-cli/reference/commands/slack_uninstall) | Uninstall the app from a team
| [`slack upgrade`](/slack-cli/reference/commands/slack_upgrade) | Checks for available updates to the CLI or SDK
| [`slack version`](/slack-cli/reference/commands/slack_version) | Print the version number
| [`slack activity`](/tools/slack-cli/reference/commands/slack_activity) | Display the app activity logs from the Slack Platform
| [`slack app`](/tools/slack-cli/reference/commands/slack_app) | Install, uninstall, and list teams with the app installed
| [`slack auth`](/tools/slack-cli/reference/commands/slack_auth) | Add and remove local team authorizations
| [`slack collaborator`](/tools/slack-cli/reference/commands/slack_collaborator) | Manage app collaborators
| [`slack create`](/tools/slack-cli/reference/commands/slack_create) | Create a Slack project
| [`slack datastore`](/tools/slack-cli/reference/commands/slack_datastore) | Query an app's datastore
| [`slack delete`](/tools/slack-cli/reference/commands/slack_delete) | Delete the app
| [`slack deploy`](/tools/slack-cli/reference/commands/slack_deploy) | Deploy the app to the Slack Platform
| [`slack doctor`](/tools/slack-cli/reference/commands/slack_doctor) | Check and report on system and app information
| [`slack env`](/tools/slack-cli/reference/commands/slack_env) | Add, remove, and list environment variables
| [`slack external-auth`](/tools/slack-cli/reference/commands/slack_external-auth) | Add and remove external authorizations and client secrets for providers in your app
| [`slack feedback`](/tools/slack-cli/reference/commands/slack_feedback) | Share feedback about your experience or project
| [`slack function`](/tools/slack-cli/reference/commands/slack_function) | Manage the functions of an app
| [`slack install`](/tools/slack-cli/reference/commands/slack_install) | Install the app to a team
| [`slack list`](/tools/slack-cli/reference/commands/slack_list) | List all authorized accounts
| [`slack login`](/tools/slack-cli/reference/commands/slack_login) | Log in to a Slack account
| [`slack logout`](/tools/slack-cli/reference/commands/slack_logout) | Log out of a team
| [`slack manifest`](/tools/slack-cli/reference/commands/slack_manifest) | Print the app manifest of a project or app
| [`slack platform`](/tools/slack-cli/reference/commands/slack_platform) | Deploy and run apps on the Slack Platform
| [`slack run`](/tools/slack-cli/reference/commands/slack_run) | Start a local server to develop and run the app locally
| [`slack samples`](/tools/slack-cli/reference/commands/slack_samples) | List available sample apps
| [`slack trigger`](/tools/slack-cli/reference/commands/slack_trigger) | List details of existing triggers
| [`slack uninstall`](/tools/slack-cli/reference/commands/slack_uninstall) | Uninstall the app from a team
| [`slack upgrade`](/tools/slack-cli/reference/commands/slack_upgrade) | Checks for available updates to the CLI or SDK
| [`slack version`](/tools/slack-cli/reference/commands/slack_version) | Print the version number
Loading
Loading