Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timmikeladze/slack-manifest
CLI tools for interacting with a Slack App Manifest. Keep a manifest in your codebase as json file or typescript object and use slack-manifest to create, validate or update your Slack App as part of a CI/CD pipeline. Also useful for speeding up local development of Slack Apps.
https://github.com/timmikeladze/slack-manifest
manifest slack slack-app slack-bot
Last synced: 11 days ago
JSON representation
CLI tools for interacting with a Slack App Manifest. Keep a manifest in your codebase as json file or typescript object and use slack-manifest to create, validate or update your Slack App as part of a CI/CD pipeline. Also useful for speeding up local development of Slack Apps.
- Host: GitHub
- URL: https://github.com/timmikeladze/slack-manifest
- Owner: TimMikeladze
- License: mit
- Created: 2022-02-11T22:44:33.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-07T20:42:07.000Z (over 1 year ago)
- Last Synced: 2024-10-20T06:16:17.532Z (17 days ago)
- Topics: manifest, slack, slack-app, slack-bot
- Language: TypeScript
- Homepage:
- Size: 852 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# slack-manifest
CLI tools for interacting with a Slack App Manifest. Keep a manifest in your codebase as json file or typescript object and use slack-manifest to create, validate or update your Slack App as part of a CI/CD pipeline.
Also useful for speeding up local development of Slack Apps.
## Installation
```shell
yarn add slack-manifest --dev
```
## Usage
```shell
Usage: cli [options]
Options:
-a, --app_id Slack app id. Required for manifest update.
-at, --accessToken Slack app configuration access token. Required if refresh token is not provided.
-c, --create Create a Slack app with provided manifest.
-d, --delete Delete a Slack app. app_id argument is required.
-e, --environment Replace placeholders in manifest with environment variables.
-m, --manifest Path to app manifest file. Required.
-r, --rotate Print new access and refresh tokens to stdout. refreshToken argument is required.
-rt, --refreshToken Slack app configuration refresh token. Valid for only 12 hours. Required if access token is not provided.
-u, --update Update Slack app manifest with provided manifest.
-v, --validate Validate manifest file.
-h, --help display help for command
```
### Slack configuration
Before using `slack-manifest` you must first create a Slack configuration token and have a Slack app id. These values be required as arguments for the commands in `slack-manifest`.
1. Create an app configuration token for your user and workspace. https://api.slack.com/authentication/config-tokens
2. Find your Slack app id.
### Updating app manifest and how to use environment variables
To update the manifest of an already existing Slack app run the following command.
```shell
slack-manifest -u -m ./manifest.json -at -a
```
When developing a Slack app it's useful to have multiple apps representing different environments such as development, preview, and production. To simplify the process of keeping your manifest file in sync across multiple apps, you can use the `-e` flag to replace placeholders in the manifest with environment variables.
For example in the snippet of the manifest file below, `${APP_NAME}` and `${APP_DESCRIPTION}` are placeholders that will be replaced with environment variables.
```shell
APP_NAME="Example" slack-manifest -u -m ./manifest.json -at -a
```
```json
{
"display_information": {
"name": "${APP_NAME}",
"description": "${APP_DESCRIPTION}",
"background_color": "#a34761"
},
...
}
```
### Typesafe manifests with Typescript
You can define the app manifest file as a Typescript module. This provides the benefit of type checking your manifest.
First install dependencies:
```shell
yarn add ts-node typescript --dev
```
Now create a Typescript file that exports the manifest. This file will be loaded during runtime and the default export will be used. You can use it to run additional code like loading env variables.
```typescript
import dotenv from 'dotenv';
import { Manifest } from 'slack-manifest';
dotenv.config();
const manifest: Manifest = {
display_information: {
name: process.env.SLACK_APP_NAME,
description: process.env.SLACK_APP_DESCRIPTION,
background_color: '#a34761',
},
};
export default manifest;
```
In order to run `slack-manifest` use `node --experimental-specifier-resolution=node --loader ts-node/esm node_modules/slack-manifest/dist/cli.modern.js`
For example:
```shell
node --experimental-specifier-resolution=node --loader ts-node/esm node_modules/slack-manifest/dist/cli.modern.js -u -m ./manifest.ts -at -a
```
It's useful to add this command as a `package.json` script and then run it as `yarn slack-manifest -u -m ./manifest.ts -at -a `
```json
{
"scripts": {
"slack-manifest": "node --experimental-specifier-resolution=node --loader ts-node/esm node_modules/slack-manifest/dist/cli.modern.js"
}
}
```
### Validating an app manifest
A manifest file can be validated using the `-v` flag. The manifest file is also automatically validated when executing a create or update operation.
```shell
slack-manifest -v -m ./manifest.json -at
```
### Create a new app from a manifest
This will create a new Slack app with the provided manifest and returns the app id, access and refresh tokens to the console.
```shell
slack-manifest -c -m ./manifest.json -at
```
### Delete an existing app
This will permanently delete an existing Slack app.
```shell
slack-manifest -d -at -a
```
### Rotate access and refresh token
Fetch new Slack configuration access and refresh tokens. The results are printed to stdout. The refresh token is valid for only 12 hours.
```shell
slack-manifest -c -m ./manifest.json -rt
```