### Handle Slack Installation Path

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/oauth.md

Use `handleInstallPath` to let the package render the default installation page. This is suitable when no customization of the installation page is needed.

```javascript
app.get('/slack/install', async (req, res) => {
  await installer.handleInstallPath(req, res, {
    scopes: ['chat:write'],
    userScopes: ['channels:read'],
    metadata: 'some_metadata',
  });
});
```

--------------------------------

### Authorize and Fetch Installation Data

Source: https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/README.md

Use `installer.authorize()` to fetch a subset of installation data, or `installer.installationStore.fetchInstallation()` to retrieve the entire saved installation object.

```javascript
// installer.authorize takes in an installQuery as an argument
// installQuery = {teamId: 'string', enterpriseId: 'string', userId: string, conversationId: 'string', isEnterpriseInstall: boolean};
const result = installer.authorize({teamId: 'my-team-ID'});
/*
result = {
  botToken: '',
  userToken: '',
  botId: '',
  botUserId: '',
  teamId: '';
  enterpriseId: '';
}
*/
```

```javascript
// installer.installationStore.fetchInstallation takes in an installQuery as an argument
// installQuery = {teamId: 'string', enterpriseId: 'string', userId: 'string', conversationId: 'string', isEnterpriseInstall: boolean};
// returns an installation object
const result = await installer.installationStore.fetchInstallation({teamId:'my-team-ID', enterpriseId:'my-enterprise-ID'});
```

--------------------------------

### Custom Installation Store Implementation

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/oauth.md

Implement `storeInstallation`, `fetchInstallation`, and `deleteInstallation` to manage Slack app installation data in your database. This example shows how to handle both enterprise-wide and single-team installations.

```javascript
const installer = new InstallProvider({
  clientId: process.env.SLACK_CLIENT_ID,
  clientSecret: process.env.SLACK_CLIENT_SECRET,
  stateSecret: process.env.SLACK_STATE_SECRET,
  installationStore: {
    // takes in an installation object as an argument
    // returns nothing
    storeInstallation: async (installation) => {
      // replace myDB.set with your own database or OEM setter
      if (installation.isEnterpriseInstall) {
        // support for org wide app installation
        return myDB.set(installation.enterprise.id, installation);
      } else {
        // single team app installation
        return myDB.set(installation.team.id, installation);
      }
      throw new Error('Failed saving installation data to installationStore');
    },
    // takes in an installQuery as an argument
    // installQuery = {teamId: 'string', enterpriseId: 'string', userId: 'string', conversationId: 'string', isEnterpriseInstall: boolean};
    // returns installation object from database
    fetchInstallation: async (installQuery) => {
      // replace myDB.get with your own database or OEM getter
      if (installQuery.isEnterpriseInstall && installQuery.enterpriseId !== undefined) {
        // org wide app installation lookup
        return await myDB.get(installQuery.enterpriseId);
      }
      if (installQuery.teamId !== undefined) {
        // single team app installation lookup
        return await myDB.get(installQuery.teamId);
      }
      throw new Error('Failed fetching installation');
    },
    // takes in an installQuery as an argument
    // installQuery = {teamId: 'string', enterpriseId: 'string', userId: 'string', conversationId: 'string', isEnterpriseInstall: boolean};
    // returns nothing
    deleteInstallation: async (installQuery) => {
      // replace myDB.get with your own database or OEM getter
      if (installQuery.isEnterpriseInstall && installQuery.enterpriseId !== undefined) {
        // org wide app installation deletion
        return await myDB.delete(installQuery.enterpriseId);
      }
      if (installQuery.teamId !== undefined) {
        // single team app installation deletion
        return await myDB.delete(installQuery.teamId);
      }
      throw new Error('Failed to delete installation');
    },
  },
});

```

--------------------------------

### Fetch Extended Slack Installation Data

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/oauth.md

Retrieve the complete saved installation data using `installer.installationStore.fetchInstallation()`. This method requires an `installQuery` object and returns the full installation details.

```javascript
const result = await installer.installationStore.fetchInstallation({teamId:'my-team-ID', enterpriseId:'my-enterprise-ID'});
```

--------------------------------

### handleInstallPath()

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/InstallProvider.md

Handles requests to the install path (e.g., `/slack/install`) from an app installer.

```APIDOC
## handleInstallPath()

### Description
Handles the install path (the default is `/slack/install`) requests from an app installer.

### Parameters

#### req
* **`IncomingMessage`** - Required - The incoming request object.
#### res
* **`ServerResponse`** - Required - The server response object.
#### options
* **`InstallPathOptions`** (`object`) - Optional - Options for handling the install path.
#### installOptions
* **`InstallURLOptions`** (`object`) - Optional - Options for the installation process.

### Returns
* **`Promise<void>`** - A promise that resolves when the install path has been handled.
```

--------------------------------

### Initialize InstallProvider for V2 OAuth

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/oauth.md

Initialize the InstallProvider with your Slack app's client ID, client secret, and a state secret. This setup is for V2 OAuth and stores installations in memory (not recommended for production).

```javascript
const { InstallProvider } = require('@slack/oauth');

// initialize the installProvider
const installer = new InstallProvider({
  clientId: process.env.SLACK_CLIENT_ID,
  clientSecret: process.env.SLACK_CLIENT_SECRET,
  stateSecret: process.env.SLACK_STATE_SECRET,
});
```

--------------------------------

### fetchInstallation

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/InstallationStore.md

Fetches installation information based on the provided query. It returns a Promise that resolves with the Installation object.

```APIDOC
## fetchInstallation(query, logger?)

### Description
Fetches installation information based on the provided query. It returns a Promise that resolves with the Installation object.

### Method
fetchInstallation

### Parameters
#### query
- **query** (`InstallationQuery<boolean>`) - Required - The query object to find the installation.
#### logger?
- **logger** (`Logger`) - Optional - A logger instance for logging.

### Returns
- `Promise<Installation<"v1" | "v2", boolean>>` - A promise that resolves with the fetched installation data.
```

--------------------------------

### app.install()

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/cli-test/variables/SlackCLI.md

Installs a Slack application. This function corresponds to the `slack app install` command.

```APIDOC
## app.install()

### Description
Installs a Slack application.

### Method
`app.install`

### Parameters
#### args
- `args` (ProjectCommandArguments) - Required - Arguments for the project command.

### Returns
- `Promise<string>` - The command output.
```

--------------------------------

### Custom Installation Store Implementation

Source: https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/README.md

Implement a custom installation store by providing `storeInstallation`, `fetchInstallation`, and `deleteInstallation` methods to the `InstallProvider`. This allows you to save and retrieve installation data to your own database.

```javascript
const installer = new InstallProvider({
  clientId: process.env.SLACK_CLIENT_ID,
  clientSecret: process.env.SLACK_CLIENT_SECRET,
  stateSecret: process.env.SLACK_STATE_SECRET,
  installationStore: {
    // takes in an installation object as an argument
    // returns nothing
    storeInstallation: async (installation) => {
      // replace myDB.set with your own database or OEM setter
      if (installation.isEnterpriseInstall) {
        // support for org wide app installation
        return myDB.set(installation.enterprise.id, installation);
      } else {
        // single team app installation
        return myDB.set(installation.team.id, installation);
      }
      throw new Error('Failed saving installation data to installationStore');
    },
    // takes in an installQuery as an argument
    // installQuery = {teamId: 'string', enterpriseId: 'string', userId: 'string', conversationId: 'string', isEnterpriseInstall: boolean};
    // returns installation object from database
    fetchInstallation: async (installQuery) => {
      // replace myDB.get with your own database or OEM getter
      if (installQuery.isEnterpriseInstall && installQuery.enterpriseId !== undefined) {
        // org wide app installation lookup
        return await myDB.get(installQuery.enterpriseId);
      }
      if (installQuery.teamId !== undefined) {
        // single team app installation lookup
        return await myDB.get(installQuery.teamId);
      }
      throw new Error('Failed fetching installation');
    },
    // takes in an installQuery as an argument
    // installQuery = {teamId: 'string', enterpriseId: 'string', userId: 'string', conversationId: 'string', isEnterpriseInstall: boolean};
    // returns nothing
    deleteInstallation: async (installQuery) => {
      // replace myDB.get with your own database or OEM getter
      if (installQuery.isEnterpriseInstall && installQuery.enterpriseId !== undefined) {
        // org wide app installation deletion
        return await myDB.delete(installQuery.enterpriseId);
      }
      if (installQuery.teamId !== undefined) {
        // single team app installation deletion
        return await myDB.delete(installQuery.teamId);
      }
      throw new Error('Failed to delete installation');
    },
  },
});
```

--------------------------------

### Run Example Script (Tooling Token Required)

Source: https://github.com/slackapi/node-slack-sdk/blob/main/prod-server-integration-tests/README.md

Execute an example script that requires the SLACK_TOOLING_TOKEN environment variable.

```bash
node scripts/apps_manifest_test.js
```

--------------------------------

### Run Example Script (Grid Tokens Required)

Source: https://github.com/slackapi/node-slack-sdk/blob/main/prod-server-integration-tests/README.md

Execute an example script for managing user sessions that requires SLACK_SDK_TEST_GRID_*_TOKEN environment variables.

```bash
node scripts/admin/usersSessionSettings.js
```

--------------------------------

### authorize()

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/InstallProvider.md

Fetches installation data from the `installationStore`. This method is used to retrieve existing installation information.

```APIDOC
## authorize()

### Description
Fetches data from the installationStore.

### Parameters

#### source
* **`InstallationQuery`** (`object`) - Required - An object specifying the query parameters for fetching installation data.

### Returns
* **`Promise<AuthorizeResult>`** - A promise that resolves with the authorization result.
```

--------------------------------

### Install @slack/socket-mode

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/migration/migrating-socket-mode-package-to-v2.md

Install the @slack/socket-mode package using npm.

```bash
npm i @slack/socket-mode
```

--------------------------------

### fetchInstallation

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/MemoryInstallationStore.md

Fetches a Slack installation from the in-memory store.

```APIDOC
## fetchInstallation

### Description

Fetches a Slack installation from the in-memory store based on the provided query.

### Parameters

#### query

- **query** (`InstallationQuery<boolean>`) - Required - An object that specifies the criteria for finding the installation to fetch.

#### logger?

- **logger?** (`Logger`) - Optional - A logger instance for capturing logs during the operation.

### Returns

`Promise<Installation<"v1" | "v2", boolean>>` - A promise that resolves with the found installation details.
```

--------------------------------

### Customizing OAuth Success and Failure Handlers

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/oauth.md

This example shows how to provide custom functions for handling successful OAuth installations and failures, allowing for tailored user experiences and responses.

```javascript
const callbackOptions = {
  success: (installation, installOptions, req, res) => {
    // Do custom success logic here
    // Tips:
    // - Inspect the metadata with `installOptions.metadata`
    // - Add javascript and css in the htmlResponse using the <script> and <style> tags
    const htmlResponse = `<html><body>Success!</body></html>`
    res.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' });
    res.end(htmlResponse);
  },
  failure: (error, installOptions , req, res) => {
    // Do custom failure logic here
    res.writeHead(500, { 'Content-Type': 'text/html; charset=utf-8' });
    res.end('<html><body><h1>Oops, Something Went Wrong! Please Try Again or Contact the App Owner</h1></body></html>');
  }
}
app.get('/slack/oauth_redirect', (req, res) => {
  installer.handleCallback(req, res, callbackOptions);
});
```

--------------------------------

### Install https-proxy-agent

Source: https://github.com/slackapi/node-slack-sdk/wiki/Migration-Guide-for-v4

Install the necessary package for proxy support.

```bash
$ npm install --save https-proxy-agent
```

--------------------------------

### Installation Interface

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/Installation.md

Represents an individual installation of a Slack app, normalizing OAuth responses and accommodating both workspace and enterprise installs. It is designed for use with InstallationStore implementations.

```APIDOC
## Interface: Installation<AuthVersion, IsEnterpriseInstall>

### Description
An individual installation of the Slack app. This interface creates a representation for installations that normalizes the responses from OAuth grant exchanges across auth versions (`oauth.v2.access` and `oauth.access`). It uses generic placeholder types `AuthVersion` and `IsEnterpriseInstall` to describe differences between auth versions and installation types (workspace vs. enterprise).

This representation is designed for both producing data to be stored by an `InstallationStore` and consuming data fetched from one. It's advised to store as much data as possible to maximize return values from `fetchInstallation()`.

### Type Parameters

#### AuthVersion
`AuthVersion` *extends* `"v1"` | `"v2"` = `"v1"` | `"v2"`

#### IsEnterpriseInstall
`IsEnterpriseInstall` *extends* `boolean` = `boolean`

### Properties

#### appId?
`optional appId: AuthVersion extends "v2" ? string : undefined;`

The App ID, which does not vary per installation. Left as undefined when not returned from fetch.

#### authVersion?
`optional authVersion: AuthVersion;`

The version of Slack's auth flow that produced this installation. Synthesized as `v2` when not present.

#### bot?
`optional bot: object;`

Represents the bot token and associated information for the installation.

##### expiresAt?
`optional expiresAt: number;`

##### id
`id: string;`

##### refreshToken?
`optional refreshToken: string;`

##### scopes
`scopes: string[];`

##### token
`token: string;`

##### userId
`userId: string;`

#### enterprise
`enterprise: IsEnterpriseInstall extends true ? EnterpriseInfo : EnterpriseInfo | undefined;`

When the installation is an enterprise install or when the installation occurs on the org to acquire `admin` scope, the name and ID of the enterprise org.

#### enterpriseUrl?
`optional enterpriseUrl: AuthVersion extends "v2" ? string : undefined;`

When the installation is an enterprise org install, the URL of the landing page for all workspaces in the org. Left as undefined when not returned from fetch.

#### incomingWebhook?
`optional incomingWebhook: object;`

Represents incoming webhook details for the installation.

##### channel?
`optional channel: string;`

Left as undefined when not returned from fetch.
```

--------------------------------

### Generate Basic Installation URL

Source: https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/README.md

Use this method to create a basic installation URL. At a minimum, you must provide the required scopes for your app.

```javascript
installer.generateInstallUrl({
  // Add the scopes your app needs
  scopes: ['channels:read']
})
```

--------------------------------

### Install @slack/web-api

Source: https://github.com/slackapi/node-slack-sdk/wiki/Migration-Guide-for-web‐api-v7

Install the @slack/web-api package using npm. This is the first step for migrating to v7.

```bash
npm i @slack/web-api
```

--------------------------------

### Run Example Script (Bot Token Required)

Source: https://github.com/slackapi/node-slack-sdk/blob/main/prod-server-integration-tests/README.md

Execute example scripts that require the SLACK_SDK_TEST_BOT_TOKEN environment variable.

```bash
node scripts/auth_test.js
node scripts/pagination.js
node scripts/conversations_invite.js
```

--------------------------------

### Install @slack/webhook

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/webhook.md

Install the @slack/webhook package using npm.

```shell
npm install @slack/webhook
```

--------------------------------

### Run Example Script (No Token Needed)

Source: https://github.com/slackapi/node-slack-sdk/blob/main/prod-server-integration-tests/README.md

Execute an example script that does not require any Slack API tokens.

```bash
node scripts/api_test.js
```

--------------------------------

### Generate Slack Installation URL

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/oauth.md

Dynamically generate an installation URL using `generateInstallUrl` for custom installation pages. This method requires at least a `scopes` property in its options.

```javascript
app.get('/slack/install', async (req, res, next) => {
  // feel free to modify the scopes
  const url = await installer.generateInstallUrl({
    scopes: ['channels:read'],
  })

  res.send(`<a href=${url}><img alt=""Add to Slack"" height="40" width="139" src="https://platform.slack-edge.com/img/add_to_slack.png" srcset="https://platform.slack-edge.com/img/add_to_slack.png 1x, https://platform.slack-edge.com/img/add_to_slack@2x.png 2x" /></a>`);
});
```

--------------------------------

### Installation Object Properties

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/Installation.md

This object represents the installation details obtained during the OAuth flow. It includes information about the access token, team, user, and installation context.

```APIDOC
## Installation Object

### Description
Represents the details of an OAuth installation.

### Properties

- **channelId?** (string) - Optional. The ID of the channel, left undefined if not returned from fetch.
- **configurationUrl?** (string) - Optional. The URL for configuration, left undefined if not returned from fetch.
- **url** (string) - The URL associated with the installation.
- **isEnterpriseInstall?** (IsEnterpriseInstall) - Optional. Indicates if the installation was performed on an enterprise org. Defaults to `false` if not present.
- **metadata?** (string) - Optional. A string value that can be held in the state parameter in the OAuth flow.
- **team** (object | undefined) - Information about the team. This is `undefined` if `IsEnterpriseInstall` is `true`.
- **tokenType?** (string) - Optional. The token type, typically 'bot', left undefined if not returned from fetch.
- **user** (object) - Information about the user associated with the installation.
  - **expiresAt?** (number | undefined) - Optional. The expiration time of the token, only available for `AuthVersion` other than 'v1'.
  - **id** (string) - The ID of the user.
  - **refreshToken?** (string | undefined) - Optional. The refresh token, only available for `AuthVersion` other than 'v1'.
  - **scopes** (string[] | undefined) - The scopes associated with the token. Can be `undefined` for `AuthVersion` other than 'v1'.
  - **token** (string | undefined) - The access token. Can be `undefined` for `AuthVersion` other than 'v1'.
```

--------------------------------

### handleInstallPath Method

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/InstallProvider.md

Handles requests to the install path (default is /slack/install) from an app installer. It redirects the user to the Slack authorization URL.

```typescript
handleInstallPath(
   req,
   res,
   options?,
   installOptions?
): Promise<void>;
```

--------------------------------

### Run Example Script (Socket Mode Token Required)

Source: https://github.com/slackapi/node-slack-sdk/blob/main/prod-server-integration-tests/README.md

Execute an example script that requires the SLACK_SDK_TEST_SOCKET_MODE_APP_TOKEN environment variable for Socket Mode.

```bash
node scripts/socket-mode.js
```

--------------------------------

### start

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/socket-mode/classes/SocketModeClient.md

Starts a Socket Mode session, enabling message sending and receiving.

```APIDOC
## start()

### Description
Starts a Socket Mode session. This method must be called before sending or receiving messages, or before disconnecting the client.

### Method
`start(): Promise<AppsConnectionsOpenResponse>`

### Returns
- `Promise<AppsConnectionsOpenResponse>` - A promise that resolves with the `AppsConnectionsOpenResponse` object upon successful connection.
```

--------------------------------

### Configure InstallProvider with Custom HTML

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/oauth.md

Initialize `InstallProvider` with options, including a function to render custom HTML for the installation path. This allows for a customized 'Install my app!' button.

```javascript
const { InstallProvider } = require('@slack/oauth');

// initialize the installProvider
const installer = new InstallProvider({
  clientId: process.env.SLACK_CLIENT_ID,
  clientSecret: process.env.SLACK_CLIENT_SECRET,
  stateSecret: process.env.SLACK_STATE_SECRET,
  renderHtmlForInstallPath: (url) => `<html><body><a href="${url}">Install my app!</a></body></html>`
});
```

--------------------------------

### Generate Slack Installation URL with Metadata

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/oauth.md

Generate an installation URL with custom metadata to capture session state. This metadata will be available after the app installation is complete and should not contain secret information.

```javascript
installer.generateInstallUrl({
  // Add the scopes your app needs
  scopes: ['channels:read'],
  metadata: JSON.stringify({some:'sessionState'})
})
```

--------------------------------

### Install Slack App

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/cli-test/variables/SlackCLI.md

Use this function to install a Slack application. It requires project arguments.

```typescript
install: (args) => Promise<string>;
```

--------------------------------

### Install @slack/rtm-api

Source: https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/README.md

Install the RTM API client package using npm.

```shell
$ npm install @slack/rtm-api
```

--------------------------------

### Define fetchInstallation Method

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/InstallationStore.md

This method is required and is used to retrieve installation data from the store. It takes a query object and an optional logger, returning a Promise that resolves to Installation data.

```typescript
fetchInstallation: (query, logger?) => Promise<Installation<"v1" | "v2", boolean>>;
```

--------------------------------

### Install @slack/logger

Source: https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/README.md

Install the package using npm. This is the first step to using the logger in your Node.js project.

```shell
$ npm install @slack/logger
```

--------------------------------

### Authorize Slack Installation

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/oauth.md

Use `installer.authorize()` to fetch basic installation data like bot and user tokens. It requires an `installQuery` object containing team or enterprise identifiers.

```javascript
const result = installer.authorize({teamId: 'my-team-ID'});
/*
result = {
  botToken: '',
  userToken: '',
  botId: '',
  botUserId: '',
  teamId: '';
  enterpriseId: '';
}
*/
```

--------------------------------

### slackLists.download.start

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/classes/Methods.md

Start a download job for a list.

```APIDOC
## POST slackLists.download.start

### Description
Start a download job for a list.

### Method
POST

### Endpoint
/slackLists.download.start

### Parameters
#### Request Body
- **listId** (string) - Required - The ID of the list to download.

### Request Example
{
  "example": "{\"listId\": \"L12345\"}"
}

### Response
#### Success Response (200)
- **jobId** (string) - The ID of the download job.

#### Response Example
{
  "example": "{\"jobId\": \"job_abc123\"}"
}
```

--------------------------------

### Install Node.js Dependencies

Source: https://github.com/slackapi/node-slack-sdk/blob/main/examples/openid-connect/README.md

Run this command in your terminal to install all the necessary packages for the Node.js application.

```bash
npm install
```

--------------------------------

### Install Slack SDK Packages with npm

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/index.md

Use npm to install the @slack/web-api and @slack/oauth packages. This command saves the packages to your package.json file.

```shell
npm install @slack/web-api @slack/oauth
```

--------------------------------

### storeInstallation

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/MemoryInstallationStore.md

Stores a Slack installation in the in-memory store.

```APIDOC
## storeInstallation

### Description

Stores a Slack installation in the in-memory store.

### Parameters

#### installation

- **installation** (`Installation`) - Required - The installation object to store.

#### logger?

- **logger?** (`Logger`) - Optional - A logger instance for capturing logs during the operation.

### Returns

`Promise<void>` - A promise that resolves when the installation has been stored.
```

--------------------------------

### Example channel_ids Array

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/interfaces/WorkflowsFeaturedListArguments.md

Provides an example of how to format the channel_ids array for the WorkflowsFeaturedListArguments.

```typescript
["C012345678", "C987654321"]
```

--------------------------------

### Install Dependencies and Lint Code

Source: https://github.com/slackapi/node-slack-sdk/blob/main/AGENTS.md

Install all project dependencies from the repository root and run linting checks using Biome. Fix linting issues with the provided command.

```bash
npm install

lint all packages (Biome)
npm run lint
npm run lint:fix
```

--------------------------------

### Install @slack/oauth Package

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/oauth.md

Install the @slack/oauth package using npm. This is the first step before building your Slack app's OAuth flow.

```shell
$ npm install @slack/oauth
```

--------------------------------

### Optional Enterprise Install Interface

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/Installation.md

Represents whether the installation was performed on an enterprise organization. Defaults to false if not present.

```typescript
optional isEnterpriseInstall: IsEnterpriseInstall;
```

--------------------------------

### Example Usage of Blocks Property

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/type-aliases/FilesCompleteUploadExternalArguments.md

Provides an example of how to structure the 'blocks' argument for rich text content.

```typescript
[{"type": "section", "text": {"type": "plain_text", "text": "Hello world"}}]
```

--------------------------------

### Install @slack/cli-test Package

Source: https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/README.md

Install the @slack/cli-test package using npm. This is the first step to using the library for automating the Slack CLI.

```bash
npm install @slack/cli-test
```

--------------------------------

### beforeInstallation Callback

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/CallbackOptions.md

An optional function to run before a Slack app installation. It can prevent the installation by returning false and must handle the HTTP response by calling callbackRes.end() in that case.

```typescript
optional beforeInstallation: (options, callbackReq, callbackRes) => Promise<boolean>;
```

--------------------------------

### Define storeInstallation Method

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/InstallationStore.md

This method is required and is used to save installation data to the store. It accepts an installation object and an optional logger, returning a Promise that resolves when the data is stored.

```typescript
storeInstallation<AuthVersion>(installation, logger?): Promise<void>;
```

--------------------------------

### Start Platform Run

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/cli-test/variables/SlackCLI.md

Starts a `slack run` process. Returns a ShellProcess object that must be stopped using `runStop`.

```typescript
runStart: (args) => Promise<ShellProcess>;
```

--------------------------------

### apps.event.authorizations.list

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/classes/Methods.md

Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.

```APIDOC
## apps.event.authorizations.list

### Description
Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.

### See
[`apps.event.authorizations.list` API reference](https://docs.slack.dev/reference/methods/apps.event.authorizations.list)
```

--------------------------------

### Run the Initial Node.js Script

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/getting-started.md

Execute your Node.js script from the command line to verify the setup. This command runs the tutorial.js file and should output the initial log message.

```shell
$ node tutorial.js
```

--------------------------------

### FileInstallationStore storeInstallation Method

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/FileInstallationStore.md

Stores a Slack installation. This method is part of the InstallationStore interface.

```typescript
storeInstallation(installation, logger?): Promise<void>;
```

--------------------------------

### Override Default Hooks in slack.json

Source: https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-hooks/README.md

Customize hook behavior by defining them in your application's slack.json file. This example overrides the 'get-hooks' and 'start' hooks.

```json
{
  "hooks": {
    "get-hooks": "NODE_NO_WARNINGS=1 npx -q --no-install -p @slack/cli-hooks slack-cli-get-hooks",
    "start": "npm run dev"
  }
}
```

--------------------------------

### Install Node Slack SDK Packages

Source: https://github.com/slackapi/node-slack-sdk/blob/main/README.md

Install the Web API and Socket Mode packages using npm or yarn. These packages are essential for interacting with Slack.

```shell
$ npm install @slack/web-api @slack/socket-mode

# Or, if you prefer yarn
$ yarn add @slack/web-api @slack/socket-mode
```

--------------------------------

### List App Event Authorizations

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/classes/Methods.md

Use this method to get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.

```typescript
list: MethodWithRequiredArgument<AppsEventAuthorizationsListArguments, AppsEventAuthorizationsListResponse>;
```

--------------------------------

### FileInstallationStore fetchInstallation Method

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/FileInstallationStore.md

Fetches a Slack installation based on the provided query. This method is part of the InstallationStore interface.

```typescript
fetchInstallation(query, logger?): Promise<Installation<"v1" | "v2", boolean>>;
```

--------------------------------

### storeInstallation

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/FileInstallationStore.md

Stores a Slack OAuth installation. This method is part of the InstallationStore interface.

```APIDOC
## storeInstallation

### Description
Stores a Slack OAuth installation.

### Method
`storeInstallation(installation, logger?): Promise<void>`

### Parameters
#### installation
- **installation** (`Installation`) - Required - The installation data to store.
#### logger?
- **logger?** (`Logger`) - Optional - A logger instance for capturing logs.
```

--------------------------------

### fetchInstallation

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/FileInstallationStore.md

Fetches a Slack OAuth installation based on the provided query. This method is part of the InstallationStore interface.

```APIDOC
## fetchInstallation

### Description
Fetches a Slack OAuth installation.

### Method
`fetchInstallation(query, logger?): Promise<Installation<"v1" | "v2", boolean>>`

### Parameters
#### query
- **query** (`InstallationQuery<boolean>`) - Required - The query to identify the installation to fetch.
#### logger?
- **logger?** (`Logger`) - Optional - A logger instance for capturing logs.

### Returns
- `Promise<Installation<"v1" | "v2", boolean>>` - A promise that resolves with the found installation.
```

--------------------------------

### afterInstallation Callback

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/CallbackOptions.md

An optional function to run after a Slack app installation. It can prevent the installation from being stored by returning false and must handle the HTTP response by calling callbackRes.end() in that case.

```typescript
optional afterInstallation: (installation, options, callbackReq, callbackRes) => Promise<boolean>;
```

--------------------------------

### platform.activityTailStart()

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/cli-test/variables/SlackCLI.md

Starts tailing platform activity and waits for a specified sequence. This command is invoked via `slack platform activity`.

```APIDOC
## platform.activityTailStart()

### Description
Starts tailing platform activity and waits for a specified sequence to continue with the test.

### Method
Not applicable (CLI command)

### Endpoint
Not applicable (CLI command)

### Parameters
#### args
- **ProjectCommandArguments** (object) - Required - Project-specific arguments.
- **StringWaitArgument** (object) - Required - Arguments for string waiting.
- **TimeoutArgument** (object) - Required - Arguments for timeout.

### Returns
`Promise<ShellProcess>` - A shell process object.
```

--------------------------------

### InstallProviderOptions Interface

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/InstallProviderOptions.md

The InstallProviderOptions interface defines the configuration options for setting up an OAuth provider. It includes details such as client credentials, authorization URLs, installation storage, and options for customizing the installation flow.

```APIDOC
## Interface: InstallProviderOptions

### Description

This interface defines the configuration options for setting up an OAuth provider. It includes details such as client credentials, authorization URLs, installation storage, and options for customizing the installation flow.

### Properties

#### `clientId`

- **Type**: `string`
- **Required**: Yes
- **Description**: Client ID, which can be found under the Basic Information section of your application on https://api.slack.com/apps

#### `clientSecret`

- **Type**: `string`
- **Required**: Yes
- **Description**: Client Secret, which can be found under the Basic Information section of your application on https://api.slack.com/apps

#### `installationStore?`

- **Type**: `InstallationStore`
- **Required**: No
- **Description**: Manages installation data, which can be called by both the OAuth flow and authorize() in event handling

#### `authorizationUrl?`

- **Type**: `string`
- **Required**: No
- **Description**: The slack.com authorize URL

#### `directInstall?`

- **Type**: `boolean`
- **Required**: No
- **Description**: The install path web page rendering will be skipped if true (default: false)

#### `renderHtmlForInstallPath()?`

- **Type**: `(url) => string`
- **Required**: No
- **Description**: The function for rendering the web page for the install path URL
  - **Parameters**:
    - `url` (`string`)
  - **Returns**: `string`

#### `stateCookieExpirationSeconds?`

- **Type**: `number`
- **Required**: No
- **Description**: The expiration time in seconds for the state parameter value stored via cookies

#### `legacyStateVerification?`

- **Type**: `boolean`
- **Required**: No
- **Description**: handleCallback() skips checking browser cookies if true (default: false). Enabling this option is not recommended. This is supposed to be used only for backward-compatibility with v2.4 and olders.

#### `authVersion?`

- **Type**: `
```

--------------------------------

### Install Slack Web API Package

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/getting-started.md

Install the @slack/web-api package and add it to your project's dependencies. This makes the Slack Web API client available for use in your Node.js application.

```shell
$ npm install @slack/web-api
```

--------------------------------

### Start the Node.js Application

Source: https://github.com/slackapi/node-slack-sdk/blob/main/examples/openid-connect/README.md

Execute this command to launch the sample application, which typically runs on port 3000.

```bash
npm start
```

--------------------------------

### CallbackOptions Interface

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/CallbackOptions.md

The CallbackOptions interface provides several optional methods to hook into the Slack app installation process. These methods allow you to execute custom logic before, during, or after installation, and to handle success or failure scenarios.

```APIDOC
## Interface: CallbackOptions

Defined in: [packages/oauth/src/callback-options.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L7)

### Properties

#### afterInstallation()? 

```ts
optional afterInstallation: (installation, options, callbackReq, callbackRes) => Promise<boolean>;
```

Defined in: [packages/oauth/src/callback-options.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L33)

An additional logic to run right after executing the Slack app installation with the given OAuth code parameter. When this method returns false, the InstallProvider skips storing the installation in database. You can set false when your app needs to cancel the installation (you can call auth.revoke API method for it) and then, the app needs to display an error page to the installing user. Also, when returning false, this method is responsible to call callbackRes#end() method to build complete HTTP response for end-users.

##### Parameters

- **installation** (`Installation` | `OrgInstallation`)
- **options** (`InstallURLOptions`)
- **callbackReq** (`IncomingMessage`)
- **callbackRes** (`ServerResponse`)

##### Returns

`Promise<boolean>`

***

#### beforeInstallation()? 

```ts
optional beforeInstallation: (options, callbackReq, callbackRes) => Promise<boolean>;
```

Defined in: [packages/oauth/src/callback-options.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L17)

An additional logic to run right before executing the Slack app installation with the given OAuth code parameter. When this method returns false, the InstallProvider skips the installation. You can set false when the visiting user is not eligible to proceed with the Slack app installation flow. Also, when returning false, this method is responsible for calling the callbackRes#end() method to build a complete HTTP response for end-users.

##### Parameters

- **options** (`InstallURLOptions`)
- **callbackReq** (`IncomingMessage`)
- **callbackRes** (`ServerResponse`)

##### Returns

`Promise<boolean>`

***

#### failure()? 

```ts
optional failure: (error, options, callbackReq, callbackRes) => void;
```

Defined in: [packages/oauth/src/callback-options.ts:63](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L63)

##### Parameters

- **error** (`CodedError`)
- **options** (`InstallURLOptions`)
- **callbackReq** (`IncomingMessage`)
- **callbackRes** (`ServerResponse`)

##### Returns

`void`

***

#### failureAsync()? 

```ts
optional failureAsync: (error, options, callbackReq, callbackRes) => Promise<void>;
```

Defined in: [packages/oauth/src/callback-options.ts:72](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L72)

##### Parameters

- **error** (`CodedError`)
- **options** (`InstallURLOptions`)
- **callbackReq** (`IncomingMessage`)
- **callbackRes** (`ServerResponse`)

##### Returns

`Promise<void>`

***

#### success()? 

```ts
optional success: (installation, options, callbackReq, callbackRes) => void;
```

Defined in: [packages/oauth/src/callback-options.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L43)

##### Parameters

- **installation** (`Installation` | `OrgInstallation`)
- **options** (`InstallURLOptions`)
- **callbackReq** (`IncomingMessage`)
- **callbackRes** (`ServerResponse`)

##### Returns

`void`

***

#### successAsync()? 

```ts
optional successAsync: (installation, options, callbackReq, callbackRes) => Promise<void>;
```

Defined in: [packages/oauth/src/callback-options.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L52)

##### Parameters

- **installation** (`Installation` | `OrgInstallation`)
- **options** (`InstallURLOptions`)
- **callbackReq** (`IncomingMessage`)
- **callbackRes** (`ServerResponse`)

##### Returns

`Promise<void>`
```

--------------------------------

### SLACK_TRACE_CREATE_START

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/cli-test/variables/SlackTracerId.md

Constant for tracing the start of the create operation.

```typescript
SLACK_TRACE_CREATE_START: string = 'SLACK_TRACE_CREATE_START';
```

--------------------------------

### InstallerInitializationError Code

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/enumerations/ErrorCode.md

Represents an error during the initialization of the OAuth installer.

```typescript
InstallerInitializationError: "slack_oauth_installer_initialization_error";
```

--------------------------------

### InstallationQuery Interface Properties

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/InstallationQuery.md

Defines the properties available for querying installation details. Note that teamId is required for non-enterprise installs, while enterpriseId is required for enterprise installs. conversationId and userId are optional.

```typescript
conversationId?: string;
```

```typescript
enterpriseId: isEnterpriseInstall extends true ? string : string | undefined;
```

```typescript
isEnterpriseInstall: isEnterpriseInstall;
```

```typescript
teamId: isEnterpriseInstall extends false ? string : undefined;
```

```typescript
userId?: string;
```

--------------------------------

### SLACK_TRACE_PLATFORM_RUN_START Constant

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/cli-test/variables/SlackTracerId.md

Indicates the start of a Slack platform run.

```typescript
SLACK_TRACE_PLATFORM_RUN_START: string = 'SLACK_TRACE_PLATFORM_RUN_START';
```

--------------------------------

### Install @slack/cli-hooks

Source: https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-hooks/README.md

Add the @slack/cli-hooks package as a development dependency to your project.

```sh
$ npm install --save-dev @slack/cli-hooks
```

--------------------------------

### Constructor

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/MemoryInstallationStore.md

Initializes a new instance of the MemoryInstallationStore class.

```APIDOC
## Constructor

### Description

Initializes a new instance of the MemoryInstallationStore class.

### Returns

`MemoryInstallationStore` - A new instance of the MemoryInstallationStore.
```

--------------------------------

### Example trigger_ids for WorkflowsFeaturedRemoveArguments

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/interfaces/WorkflowsFeaturedRemoveArguments.md

Provides an example of how to format the trigger_ids array when removing featured workflows.

```json
["Ft012345", "Ft012346"]
```

--------------------------------

### Get File Info

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/classes/WebClient.md

Gets information about a file. Refer to the files.info API reference for more details.

```typescript
info: MethodWithRequiredArgument<FilesInfoArguments, FilesInfoResponse>;
```

--------------------------------

### Install https-proxy-agent

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/rtm-api.md

Install the https-proxy-agent package to enable proxy support for your RTM client. Save it to your package.json.

```shell
$ npm install https-proxy-agent
```

--------------------------------

### authorize Method

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/InstallProvider.md

Fetches installation data from the installationStore based on a query. Returns a Promise that resolves to an AuthorizeResult.

```typescript
authorize(source): Promise<AuthorizeResult>;
```

--------------------------------

### Constructor

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/InstallProvider.md

Initializes a new instance of the InstallProvider class. It requires an InstallProviderOptions object for configuration.

```APIDOC
## Constructor

### Description
Initializes a new instance of the InstallProvider class. Refer to the `InstallProviderOptions` interface for the details of constructor arguments.

### Parameters

#### __namedParameters
* **`InstallProviderOptions`** (`object`) - Required - Options for configuring the InstallProvider.

### Returns
* **`InstallProvider`** - An instance of the InstallProvider class.
```

--------------------------------

### InstallationQuery Interface

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/interfaces/InstallationQuery.md

This interface is used to query installation details. It has conditional properties based on the `isEnterpriseInstall` type parameter.

```APIDOC
## Interface: InstallationQuery<isEnterpriseInstall>

Defined in: [packages/oauth/src/installation-query.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L4)

### Type Parameters

#### isEnterpriseInstall

`isEnterpriseInstall` *extends* `boolean`

### Properties

#### conversationId?

- **conversationId** (string) - Optional - The ID of the conversation.

Defined in: [packages/oauth/src/installation-query.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L8)

***

#### enterpriseId

- **enterpriseId** (string | undefined) - Required if `isEnterpriseInstall` is true, otherwise optional. The ID of the enterprise.

Defined in: [packages/oauth/src/installation-query.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L6)

***

#### isEnterpriseInstall

- **isEnterpriseInstall** (boolean) - Indicates if the installation is for an enterprise.

Defined in: [packages/oauth/src/installation-query.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L4)

***

#### teamId

- **teamId** (undefined) - Required if `isEnterpriseInstall` is false, otherwise undefined. The ID of the team.

Defined in: [packages/oauth/src/installation-query.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L5)

***

#### userId?

- **userId** (string) - Optional - The ID of the user.

Defined in: [packages/oauth/src/installation-query.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L7)
```

--------------------------------

### Initialize InstallProvider for Classic (V1) OAuth

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/oauth.md

Initialize the InstallProvider for classic Slack apps using V1 OAuth. This requires setting the 'authVersion' option to 'v1'.

```javascript
const { InstallProvider } = require('@slack/oauth');

// initialize the installProvider
const installer = new InstallProvider({
  clientId: process.env.SLACK_CLIENT_ID,
  clientSecret: process.env.SLACK_CLIENT_SECRET,
  stateSecret: process.env.SLACK_STATE_SECRET,
  authVersion: 'v1' //required for classic Slack apps
});
```

--------------------------------

### Initialize a New Node.js Project

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/getting-started.md

Use npm init to create a new package.json file for your project. This command prompts you for project details and sets up the basic project structure.

```shell
$ npm init
```

--------------------------------

### platform.runStart()

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/cli-test/variables/SlackCLI.md

Starts the `slack run` process. `runStop` must be used to stop the process. This command is invoked via `slack run`.

```APIDOC
## platform.runStart()

### Description
Starts the `slack run` process. `runStop` must be used to stop the process.

### Method
Not applicable (CLI command)

### Endpoint
Not applicable (CLI command)

### Parameters
#### args
- **ProjectCommandArguments** (object) - Required - Project-specific arguments.
- **RunDeployArguments** (object) - Required - Arguments for running deployment.
- **TimeoutArgument** (object) - Required - Arguments for timeout.

### Returns
`Promise<ShellProcess>` - A shell object to kill it explicitly in the test case via `runStop`.
```

--------------------------------

### MultiChannelsSelect with Initial Channels

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/interfaces/MultiChannelsSelect.md

Example demonstrating how to pre-select channels in a MultiChannelsSelect menu using the `initial_channels` property.

```typescript
initial_channels: string[];
```

--------------------------------

### Users Get Presence Method

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/classes/Methods.md

Represents the method to get user presence information. Requires specific arguments.

```typescript
getPresence: MethodWithRequiredArgument<UsersGetPresenceArguments, UsersGetPresenceResponse>;
```

--------------------------------

### Get reactions for an item

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/classes/Methods.md

Use this method to retrieve all reactions for a specific item. Requires the item to get reactions for.

```typescript
get: MethodWithRequiredArgument<ReactionsGetArguments, ReactionsGetResponse>;
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/slackapi/node-slack-sdk/blob/main/prod-server-integration-tests/README.md

Copy the sample environment file and edit it with your specific tokens and IDs.

```bash
cp .env.sample .env
# Edit .env and fill in your tokens/IDs
```

--------------------------------

### Create App from Template using SlackCLI

Source: https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/README.md

Demonstrates how to use the SlackCLI.createAppFromTemplate method to create a new Slack application from a specified template. Ensure the Slack CLI is installed and configured.

```typescript
import { SlackCLI } from '@slack/cli-test';
...
const createOutput = await SlackCLI.createAppFromTemplate('slackapi/deno-hello-world');
```

--------------------------------

### Get Bot Info

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/classes/Methods.md

Gets information about a bot user. Refer to the API reference for details on arguments and responses.

```typescript
info: Method<BotsInfoArguments, BotsInfoResponse>;
```

--------------------------------

### Install @slack/types

Source: https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/README.md

Install the @slack/types package using npm. This package is required for using Slack's type models.

```shell
npm install @slack/types
```

--------------------------------

### FileInstallationStore Constructor

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/oauth/classes/FileInstallationStore.md

Initializes a new instance of the FileInstallationStore class. It can optionally accept FileInstallationOptions.

```APIDOC
## Constructor FileInstallationStore

### Description
Initializes a new instance of the FileInstallationStore class.

### Parameters
#### 
- **__namedParameters?** (`FileInstallationOptions`) - Optional - Configuration options for the file store.
```

--------------------------------

### Start Real Time Messaging session (Deprecated)

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/classes/Methods.md

This method is deprecated and has been replaced by `rtm.connect`. Use `rtm.connect` for starting new RTM sessions.

```typescript
start: Method<RTMStartArguments, RtmStartResponse>;
```

--------------------------------

### Example Usage of Files Property

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/web-api/type-aliases/FilesCompleteUploadExternalArguments.md

Shows how to specify file IDs and titles when completing an external upload.

```typescript
[{"id":"F044GKUHN9Z", "title":"slack-test"}]
```

--------------------------------

### Start Platform Activity Tail

Source: https://github.com/slackapi/node-slack-sdk/blob/main/docs/english/reference/cli-test/variables/SlackCLI.md

Starts tailing platform activity, waiting for a specific sequence. Returns a ShellProcess object to manage the process.

```typescript
activityTailStart: (args) => Promise<ShellProcess>;
```