Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wearefine/slack-archive-bot
A Node cli to archive Slack channels that meet certain criteria.
https://github.com/wearefine/slack-archive-bot
archive bot cli nodejs slack
Last synced: 3 days ago
JSON representation
A Node cli to archive Slack channels that meet certain criteria.
- Host: GitHub
- URL: https://github.com/wearefine/slack-archive-bot
- Owner: wearefine
- License: mit
- Created: 2017-10-03T16:03:23.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-07T07:13:38.000Z (over 2 years ago)
- Last Synced: 2024-11-07T19:11:43.577Z (8 days ago)
- Topics: archive, bot, cli, nodejs, slack
- Language: JavaScript
- Size: 148 KB
- Stars: 11
- Watchers: 5
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Slack archive bot
================
## Summary
This is a Nodejs cli to archive Slack channels that meet certain criteria.
## Install
This project is setup to use Yarn but NPM also works.
yarn:
```sh
yarn global add slack-archivebot
```
npm:
```sh
npm install -g slack-archivebot
```
## Usage
```
Usage: slack-archivebot [options]
Options:
-V, --version output the version number
-t, --token Slack API bot token. You should probably use ARCHIVEBOT_SLACK_TOKEN as an ENV VAR.
-d, --days [n] Number of days of inactivity. Default: 30
-m, --members [n] Maximum number of members in the channel. Default: 1
-n, --never-archive [list] List of channels to never archive.
-b, --basic Only prints basic log messages. For use with cron or task runners. Default: false
-h, --help output usage information
```
You can provide the values as arguments or env vars (listed below). The cli arguments take precedence. It is highly recommended that you put the token into an environment variable. It is setup to run anytime with a recommended run of once a day or less.
## Environment Variables
ARCHIVEBOT_SLACK_TOKEN=The super secret bot [OAuth token](https://api.slack.com/apps)
ARCHIVEBOT_MEMBERS=The minimum number of members a channel can have to archive
ARCHIVEBOT_DAYS=The number of days of inactivity
ARCHIVEBOT_NEVER_ARCHIVE=Comma delimited list of channels to never archive
ARCHIVEBOT_BASIC=true || false
## Rate limits
Due to Slack's strict rate limit and given that several requests need to be made per channel. The script will run each request at a rate of 1 request per 2 seconds. This will help avoid the rate limit that Slack imposes of roughly 1 req/s. Don’t run the cli more than once every hour to avoid rate limits.
## Docker
There is now a Dockerfile that can be used to build a container to run the cli.
Using environment variables
```bash
docker run --rm -d \
-e ARCHIVEBOT_NEVER_ARCHIVE=$ARCHIVEBOT_NEVER_ARCHIVE \
-e ARCHIVEBOT_SLACK_TOKEN=$ARCHIVEBOT_SLACK_TOKEN \
-e ARCHIVEBOT_INACTIVITY_DAYS=$ARCHIVEBOT_INACTIVITY_DAYS \
slack-archivebot
```
Using flags
```bash
docker run --rm -d \
slack-archivebot -n "test" -t abc123 -d 60
```