diff --git a/README.md b/README.md index bc892d1c..e8a59f4f 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/_sidebar.json b/docs/_sidebar.json index c9ce339e..1855cf12 100644 --- a/docs/_sidebar.json +++ b/docs/_sidebar.json @@ -1,7 +1,7 @@ [ { "type": "doc", - "id": "slack-cli/index", + "id": "tools/slack-cli/index", "label": "Slack CLI", "className": "sidebar-title" }, @@ -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": "
" }, @@ -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" } ] diff --git a/docs/guides/authorizing-the-slack-cli.md b/docs/guides/authorizing-the-slack-cli.md index cb9f8f9e..061b7a23 100644 --- a/docs/guides/authorizing-the-slack-cli.md +++ b/docs/guides/authorizing-the-slack-cli.md @@ -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 diff --git a/docs/guides/deploying-with-the-slack-cli-and-github-actions.md b/docs/guides/deploying-with-the-slack-cli-and-github-actions.md index 593fc05c..07d32a43 100644 --- a/docs/guides/deploying-with-the-slack-cli-and-github-actions.md +++ b/docs/guides/deploying-with-the-slack-cli-and-github-actions.md @@ -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 @@ -10,8 +10,8 @@ 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 — 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. @@ -19,17 +19,17 @@ Once those steps have been completed, we're ready to move on to building our aut 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-` — make sure you save this token. Note that this token is connected to a specific workspace and organization. @@ -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) diff --git a/docs/guides/installing-the-slack-cli-for-mac-and-linux.md b/docs/guides/installing-the-slack-cli-for-mac-and-linux.md index cb0a3abe..55de2303 100644 --- a/docs/guides/installing-the-slack-cli-for-mac-and-linux.md +++ b/docs/guides/installing-the-slack-cli-for-mac-and-linux.md @@ -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`.] @@ -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) @@ -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.** @@ -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).** diff --git a/docs/guides/installing-the-slack-cli-for-windows.md b/docs/guides/installing-the-slack-cli-for-windows.md index f199a5df..aa39d13e 100644 --- a/docs/guides/installing-the-slack-cli-for-windows.md +++ b/docs/guides/installing-the-slack-cli-for-windows.md @@ -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`.] @@ -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.
Optional: Use an alias for the Slack CLI binary @@ -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.** @@ -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).** diff --git a/docs/guides/running-slack-cli-commands.md b/docs/guides/running-slack-cli-commands.md index 8c9d3f4d..53f27813 100644 --- a/docs/guides/running-slack-cli-commands.md +++ b/docs/guides/running-slack-cli-commands.md @@ -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 @@ -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 \ No newline at end of file +| [`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 \ No newline at end of file diff --git a/docs/guides/setting-up-ci-cd-with-the-slack-cli.md b/docs/guides/setting-up-ci-cd-with-the-slack-cli.md index 7059539a..c5c194d9 100644 --- a/docs/guides/setting-up-ci-cd-with-the-slack-cli.md +++ b/docs/guides/setting-up-ci-cd-with-the-slack-cli.md @@ -1,6 +1,6 @@ --- sidebar_label: Setting up CI/CD -slug: /slack-cli/guides/setting-up-ci-cd-with-the-slack-cli +slug: /tools/slack-cli/guides/setting-up-ci-cd-with-the-slack-cli --- @@ -52,11 +52,11 @@ An underlying philosophy of Continuous Delivery is that once code is tested as p ## Continuous Integration setup {#ci-pipeline} -Before setting up a CI/CD pipeline, you should first familiarize yourself with the [Deno](/deno-slack-sdk/guides/installing-deno) environment if you haven't already. On the CI side of things, we'll be using [Deno's built-in tools](https://deno.land/manual/tools), which allow developers to leverage tools such as GitHub Actions to add steps for testing, linting, and formatting our code. +Before setting up a CI/CD pipeline, you should first familiarize yourself with the [Deno](/tools/deno-slack-sdk/guides/installing-deno) environment if you haven't already. On the CI side of things, we'll be using [Deno's built-in tools](https://deno.land/manual/tools), which allow developers to leverage tools such as GitHub Actions to add steps for testing, linting, and formatting our code. You'll also need to accommodate requests from your network to a variety of hosts. Refer to [Which hosts are involved in the creation and execution of apps created with the Slack CLI?](https://docs.slack.dev/faq#hosts) for more details. -In addition, you'll need to obtain a service token to authorize your CI/CD setup. Refer to [CI/CD authorization](/slack-cli/guides/authorizing-the-slack-cli#ci-cd) for more details about obtaining, using, and revoking service tokens. +In addition, you'll need to obtain a service token to authorize your CI/CD setup. Refer to [CI/CD authorization](/tools/slack-cli/guides/authorizing-the-slack-cli#ci-cd) for more details about obtaining, using, and revoking service tokens. Once you've done those things, you're ready to get started! Let's walk through an example. @@ -166,9 +166,9 @@ This is the meat and potatoes of our CI setup. The pipeline is kicked off by a p This also includes calling Deno's [task runner](https://deno.land/manual/tools/task_runner) to run any unit tests we have created for our custom functions. This allows us to run all of our unit tests automatically, rather than running each one manually from the command line. In this sample, this means all of the files located in the sample app's `functions` folder ending in _test.ts_. -✨ **For more information about creating unit tests**, refer to [Testing custom functions](/deno-slack-sdk/guides/creating-custom-functions#testing). +✨ **For more information about creating unit tests**, refer to [Testing custom functions](/tools/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](/tools/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!] ::: @@ -209,10 +209,10 @@ Central to this file is calling the `slack deploy` command to deploy your app to ## Onward {#onward} -Want to learn more about how to use the Slack CLI? [Start here](/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux)! +Want to learn more about how to use the Slack CLI? [Start here](/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux)! -✨ **For more information about deploying to Slack's managed infrastructure**, refer to [Deploy to Slack](/deno-slack-sdk/guides/deploying-to-slack). +✨ **For more information about deploying to Slack's managed infrastructure**, refer to [Deploy to Slack](/tools/deno-slack-sdk/guides/deploying-to-slack). ✨ **For more information specific to different platforms**, refer to [Deploying Deno](https://deno.land/manual/advanced/deploying_deno). -✨ **Just want to write some unit tests?** Refer to [Testing custom functions](/deno-slack-sdk/guides/creating-custom-functions#testing). +✨ **Just want to write some unit tests?** Refer to [Testing custom functions](/tools/deno-slack-sdk/guides/creating-custom-functions#testing). diff --git a/docs/guides/troubleshooting-slack-cli-errors.md b/docs/guides/troubleshooting-slack-cli-errors.md index abf8bcc5..a8ae9307 100644 --- a/docs/guides/troubleshooting-slack-cli-errors.md +++ b/docs/guides/troubleshooting-slack-cli-errors.md @@ -1,13 +1,13 @@ --- sidebar_label: Troubleshooting errors -slug: /slack-cli/guides/troubleshooting-slack-cli-errors +slug: /tools/slack-cli/guides/troubleshooting-slack-cli-errors --- # Troubleshooting Slack CLI errors Troubleshooting errors can be tricky. There's a lot going on between your development environment, the Slack CLI, and your code! -View the [full list of of errors in the reference](/slack-cli/reference/errors). +View the [full list of of errors in the reference](/tools/slack-cli/reference/errors). ## VSCode and the Deno plugin {#vscode-deno} diff --git a/docs/guides/uninstalling-the-slack-cli.md b/docs/guides/uninstalling-the-slack-cli.md index ca4c6025..7c3a9348 100644 --- a/docs/guides/uninstalling-the-slack-cli.md +++ b/docs/guides/uninstalling-the-slack-cli.md @@ -1,12 +1,12 @@ --- -slug: /slack-cli/guides/uninstalling-the-slack-cli +slug: /tools/slack-cli/guides/uninstalling-the-slack-cli --- # Uninstalling the Slack CLI All good things come to an end! If you need to uninstall the Slack CLI, run the commands below. Note that these instructions will uninstall the Slack CLI, but not its dependencies. Follow [these instructions](https://docs.deno.com/runtime/manual/tools/script_installer#uninstall) to uninstall Deno. -✨ **Just need to uninstall an app?** Refer to [uninstall an app from your workspace](/deno-slack-sdk/guides/creating-an-app#uninstall-app). +✨ **Just need to uninstall an app?** Refer to [uninstall an app from your workspace](/tools/deno-slack-sdk/guides/creating-an-app#uninstall-app). diff --git a/docs/guides/using-environment-variables-with-the-slack-cli.md b/docs/guides/using-environment-variables-with-the-slack-cli.md index b966bda9..7e9f2664 100644 --- a/docs/guides/using-environment-variables-with-the-slack-cli.md +++ b/docs/guides/using-environment-variables-with-the-slack-cli.md @@ -1,19 +1,19 @@ --- sidebar_label: Using environment variables -slug: /slack-cli/guides/using-environment-variables-with-the-slack-cli +slug: /tools/slack-cli/guides/using-environment-variables-with-the-slack-cli --- # Using environment variables with the Slack CLI -Storing and using environment variables in an application allows for certain variables to be maintained outside of the code of the application. You can use environment variables from within Slack [functions](/deno-slack-sdk/guides/creating-custom-functions), [triggers](/deno-slack-sdk/guides/using-triggers), and [manifests](/deno-slack-sdk/guides/using-the-app-manifest). +Storing and using environment variables in an application allows for certain variables to be maintained outside of the code of the application. You can use environment variables from within Slack [functions](/tools/deno-slack-sdk/guides/creating-custom-functions), [triggers](/tools/deno-slack-sdk/guides/using-triggers), and [manifests](/tools/deno-slack-sdk/guides/using-the-app-manifest). ## Using environment variables with a custom function {#custom-function} -When accessing environment variables from within a [custom function](/deno-slack-sdk/guides/creating-custom-functions), where you store them differs when the app is local versus deployed. +When accessing environment variables from within a [custom function](/tools/deno-slack-sdk/guides/creating-custom-functions), where you store them differs when the app is local versus deployed. ### Storing local environment variables {#local-env-vars} -Local environment variables are stored in a `.env` file at the root of the project and made available for use in [custom functions](/deno-slack-sdk/guides/creating-custom-functions) via the `env` [context property](/deno-slack-sdk/guides/creating-custom-functions#context). +Local environment variables are stored in a `.env` file at the root of the project and made available for use in [custom functions](/tools/deno-slack-sdk/guides/creating-custom-functions) via the `env` [context property](/tools/deno-slack-sdk/guides/creating-custom-functions#context). A local `.env` file might look like this: ```env @@ -26,7 +26,7 @@ While the `.env` file should **never** be committed to source control for securi ### Storing deployed environment variables {#deployed-env-vars} -When your app is [deployed](/deno-slack-sdk/guides/deploying-to-slack), it will no longer use the `.env` file. Instead, you will have to add the environment variables using the [`env add`](/slack-cli/reference/commands/slack_env_add) command. Environment variables added with `env add` will be made available to your deployed app's [custom functions](/deno-slack-sdk/guides/creating-custom-functions) just as they are locally; see examples in the next section. +When your app is [deployed](/tools/deno-slack-sdk/guides/deploying-to-slack), it will no longer use the `.env` file. Instead, you will have to add the environment variables using the [`env add`](/tools/slack-cli/reference/commands/slack_env_add) command. Environment variables added with `env add` will be made available to your deployed app's [custom functions](/tools/deno-slack-sdk/guides/creating-custom-functions) just as they are locally; see examples in the next section. For the above example, we could run the following command before deploying our app: @@ -44,7 +44,7 @@ Your environment variables are always encrypted before being stored on our serve ### Access variables from within function {#access-function} -We can retrieve the `MY_ENV_VAR` environment variable from within a [custom Slack function](/deno-slack-sdk/guides/creating-custom-functions) via the `env` [context property](/deno-slack-sdk/guides/creating-custom-functions#context) like this: +We can retrieve the `MY_ENV_VAR` environment variable from within a [custom Slack function](/tools/deno-slack-sdk/guides/creating-custom-functions) via the `env` [context property](/tools/deno-slack-sdk/guides/creating-custom-functions#context) like this: ```javascript // functions/my_function.ts @@ -64,7 +64,7 @@ Environment variables also play an important part in making calls to a third-par ## Using environment variables with a trigger or manifest {#using-trigger-manifest} -Accessing environment variables from within a [trigger](/deno-slack-sdk/guides/using-triggers) definition or when constructing the [manifest](/deno-slack-sdk/guides/using-the-app-manifest) differs slightly from custom functions. +Accessing environment variables from within a [trigger](/tools/deno-slack-sdk/guides/using-triggers) definition or when constructing the [manifest](/tools/deno-slack-sdk/guides/using-the-app-manifest) differs slightly from custom functions. Whether your app is being run locally or already deployed, constructing these definitions happens entirely on your machine and so the environment variables stored on your machine are used. @@ -114,7 +114,7 @@ export default Manifest({ After including this new module, you may have to run [`deno cache manifest.ts`](https://docs.deno.com/runtime/manual/getting_started/command_line_interface#cache-and-compilation-flags) to refresh your local dependency cache. -Variable values such as these are commonly used to specify [outgoing domains](/deno-slack-sdk/guides/using-the-app-manifest#manifest-properties) used by functions, channel IDs for [event triggers](/deno-slack-sdk/guides/creating-event-triggers#event-object), or client IDs of an [external authentication](/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication#define) provider. But, don't let that limit you — environment variables can be used in so many other places! +Variable values such as these are commonly used to specify [outgoing domains](/tools/deno-slack-sdk/guides/using-the-app-manifest#manifest-properties) used by functions, channel IDs for [event triggers](/tools/deno-slack-sdk/guides/creating-event-triggers#event-object), or client IDs of an [external authentication](/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication#define) provider. But, don't let that limit you — environment variables can be used in so many other places! #### Requiring environment variables values {#required-manifest-variable-values} @@ -152,7 +152,7 @@ slack env add SLACK_DEBUG true Slack provides two environment variables by default, `SLACK_WORKSPACE` and `SLACK_ENV`. The workspace name is specified by `SLACK_WORKSPACE` and `SLACK_ENV` provides a distinction between the `local` and `deployed` app. Use these values if you want to have different values based on the workspace or environment that the app is installed in. -These variables are automatically included when generating the manifest or triggers only. For access from within a custom function, these variables can be set from the `.env` file or with the [`env add`](/slack-cli/reference/commands/slack_env_add) command. +These variables are automatically included when generating the manifest or triggers only. For access from within a custom function, these variables can be set from the `.env` file or with the [`env add`](/tools/slack-cli/reference/commands/slack_env_add) command. A custom `WorkspaceMapSchema` can be created and used with these variables to decide which values to use for certain instances of an app. This can be used as an alternative to a local `.env` file or in conjunction with it. The following snippet works well for inclusion in your app manifest, or for triggers (for example, to change event trigger channel IDs): diff --git a/docs/guides/using-slack-cli-on-an-enterprise-grid-organization.md b/docs/guides/using-slack-cli-on-an-enterprise-grid-organization.md index 7e9c7f22..352d0efa 100644 --- a/docs/guides/using-slack-cli-on-an-enterprise-grid-organization.md +++ b/docs/guides/using-slack-cli-on-an-enterprise-grid-organization.md @@ -1,6 +1,6 @@ --- sidebar_label: Using on Enterprise Grid -slug: /slack-cli/guides/using-slack-cli-on-an-enterprise-grid-organization +slug: /tools/slack-cli/guides/using-slack-cli-on-an-enterprise-grid-organization --- # Using Slack CLI on an Enterprise Grid organization @@ -69,7 +69,7 @@ Apps created with a legacy workspace-level authorization can still be managed by ## Requesting Admin Approval {#requesting-approval} -By default, [Admin Approval of Apps](/deno-slack-sdk/guides/controlling-permissions-for-admins) is turned on for all Slack Enterprise Grid organizations. +By default, [Admin Approval of Apps](/tools/deno-slack-sdk/guides/controlling-permissions-for-admins) is turned on for all Slack Enterprise Grid organizations. Here's what the request flow looks like when trying to install an app to an organization: @@ -86,7 +86,7 @@ If your organization turned Admin Approval of Apps off, then no approval is need While workflow apps are _installed_ on an entire organization, they do not necessarily have _access_ to every workspace in the organization. -Granting access to workspaces is done when an app is [run on a local development server](/deno-slack-sdk/guides/developing-locally) or [deployed to production](/deno-slack-sdk/guides/deploying-to-slack). The Slack CLI will prompt you to select whether to install with access to a single workspace or all workspaces in an organization. +Granting access to workspaces is done when an app is [run on a local development server](/tools/deno-slack-sdk/guides/developing-locally) or [deployed to production](/tools/deno-slack-sdk/guides/deploying-to-slack). The Slack CLI will prompt you to select whether to install with access to a single workspace or all workspaces in an organization. You can also skip the prompt and proactively grant the desired access by appending `-org-workspace-grant ` to the relevant command. diff --git a/docs/guides/using-slack-cli-with-bolt-frameworks.md b/docs/guides/using-slack-cli-with-bolt-frameworks.md index 7ec98200..2d1ce1e8 100644 --- a/docs/guides/using-slack-cli-with-bolt-frameworks.md +++ b/docs/guides/using-slack-cli-with-bolt-frameworks.md @@ -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](/bolt-js) and [Bolt for Python](/bolt-python). +You can use the Slack CLI to streamline development of apps using [Bolt for JavaScript](/tools/bolt-js) and [Bolt for Python](/tools/bolt-python). :::info[Feeling adventurous?] -To create a Bolt app using features currently under development, refer to the [experiments](/slack-cli/reference/experiments) page. +To create a Bolt app using features currently under development, refer to the [experiments](/tools/slack-cli/reference/experiments) page. ::: @@ -36,7 +36,7 @@ Your app will be cloned from the respective [JavaScript](https://github.com/slac :::info[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](/bolt-python/getting-started). +For more information, refer to [Getting started with Bolt for Python](/tools/bolt-python/getting-started). ::: diff --git a/docs/index.md b/docs/index.md index 62f90caf..388f3fb2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,11 +2,11 @@ The Slack command-line interface (CLI) allows you to create and manage Slack apps from the command line. Use it in combination with the Deno Slack SDK, or the Bolt frameworks for JavaScript and Python. -Follow the installation guide for either [MacOS / Linux](/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux) or [Windows](/slack-cli/guides/installing-the-slack-cli-for-windows) to get set up. Then, follow the the [Authorization guide](/slack-cli/guides/authorizing-the-slack-cli) to connect your workspace. +Follow the installation guide for either [MacOS / Linux](/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux) or [Windows](/tools/slack-cli/guides/installing-the-slack-cli-for-windows) to get set up. Then, follow the the [Authorization guide](/tools/slack-cli/guides/authorizing-the-slack-cli) to connect your workspace. ## Getting help -This site has lots of guides on the Slack CLI. There's also an in-depth reference both for [commands](/slack-cli/reference/commands/slack) and [errors](/slack-cli/reference/errors). +This site has lots of guides on the Slack CLI. There's also an in-depth reference both for [commands](/tools/slack-cli/reference/commands/slack) and [errors](/tools/slack-cli/reference/errors). If you otherwise get stuck, we're here to help. The following are the best ways to get assistance working through your issue: diff --git a/docs/reference/errors.md b/docs/reference/errors.md index 9f6f1286..bdf735b6 100644 --- a/docs/reference/errors.md +++ b/docs/reference/errors.md @@ -99,7 +99,7 @@ and some ways to remediate them. **Remediation**: Learn about building apps with the Deno Slack SDK: -https://tools.slack.dev/deno-slack-sdk +https://docs.slack.dev/tools/deno-slack-sdk If you are using a Bolt framework, add a deploy hook then run: `slack deploy` @@ -328,7 +328,7 @@ Learn more: https://slack.com/help/articles/201980108-Add-people-to-a-channel **Message**: Couldn't auto-update this command-line tool **Remediation**: You can manually install the latest version from: -https://tools.slack.dev/slack-cli +https://docs.slack.dev/tools/slack-cli ---