Slack Profile CLI

A command-line tool for updating Slack user profiles using the Slack API. Perfect for workspace admins who need to manage user profiles programmatically.

Available in both Node.js and Ruby!

npm install -g @jaspermayone/slack-profile-cli

gem install slack_profile

brew install jaspermayone/tap/slack-profile

Node.js version:

git clone https://github.com/jaspermayone/slack-profile-cli.git
cd slack-profile-cli/nodejs
npm install
npm link

Ruby version:

git clone https://github.com/jaspermayone/slack-profile-cli.git
cd slack-profile-cli/ruby
bundle install
rake install

1. Get your Slack token:

   • Go to https://api.slack.com/apps
   • Create a new app or select an existing one
   • Go to "OAuth & Permissions"
   • Add the users.profile:write scope
   • Install the app to your workspace
   • Copy the "User OAuth Token" (starts with xoxp-)

2. Configure your token (choose one method):

   Option 1: Environment variable (recommended for regular use)

   # Add to your ~/.bashrc, ~/.zshrc, or ~/.profile
   export SLACK_TOKEN=xoxp-your-token-here

   Option 2: .env file (for local development)

   cp .env.example .env
   # Edit .env and add your token

   Option 3: Command line flag (for one-off commands)

   slack-profile --token xoxp-your-token-here <command>

• Node.js: Best if you're already in a Node.js environment or prefer npm
• Ruby: Best if you're using Homebrew or prefer Ruby gems
• Both versions have identical features and CLI interfaces

Both versions use the same commands:

Simply run the tool without arguments for a guided experience:

slack-profile
# or
slack-profile interactive
# or with token flag
slack-profile --token xoxp-xxx interactive

This will prompt you to:

• Choose between single user or multiple users
• Choose between single field or multiple fields
• Search and select fields (with autocomplete)
• Enter field values (leave empty to clear)

slack-profile set-field -u U1234567890 -n first_name -v "John"
slack-profile set-field -u U1234567890 -n title -v "Senior Developer"
slack-profile set-field -u U1234567890 -n Xf07986PJV2R -v "U079DHX7FB6"  # Custom field

# With token flag
slack-profile --token xoxp-xxx set-field -u U1234567890 -n title -v "Engineer"

slack-profile batch-field -u U1234567890,U0987654321,U1111222233 -n title -v "Developer"
slack-profile batch-field -u U1234567890,U0987654321 -n Xf07986PJV2R -v "U079DHX7FB6"

slack-profile set-profile -u U1234567890 -p '{"first_name":"John","last_name":"Doe","title":"Developer"}'

slack-profile batch-profile -u U1234567890,U0987654321 -p '{"title":"Senior Developer","pronouns":"they/them"}'

slack-profile set-field -u U1234567890 -n title -v ""  # Clear title

# First, get custom field IDs
slack-profile list-fields

# Then set custom field values
slack-profile set-profile -u U1234567890 -p '{"fields":{"Xf0111111":{"value":"Barista","alt":""}}}'

slack-profile list-fields

slack-profile examples

• display_name - Display name (max 80 chars)
• email - Email address
• first_name - First name
• last_name - Last name
• phone - Phone number
• pronouns - Pronouns
• real_name - Full name (max 50 chars)
• start_date - Join date (Business+ only)
• title - Job title

Custom fields are set using their unique ID and the fields object:

node index.js set-profile -u U1234567890 -p '{
  "fields": {
    "Xf0111111": {
      "value": "Engineering Team",
      "alt": ""
    }
  }
}'

• text: Up to 256 characters
• long_text: Up to 5,000 characters (supports markdown)
• date: Valid date format
• link: URL (up to 256 characters)
• user: Up to 25 user IDs, comma-separated
• options_list: Must match predefined options
• tags: Array of tags (up to 75 tags, 50 chars each)

You can find user IDs in several ways:

1. From Slack URL: When viewing a user's profile, the URL contains their ID
2. From user mention: @username in Slack shows the ID in developer tools
3. Using Slack API: users.list endpoint
4. Browser extension: Various extensions can show user IDs

• Node.js 14+
• Slack workspace admin privileges
• User OAuth Token with users.profile:write scope
• Paid Slack plan (for updating other users' profiles)

• missing_scope: Add users.profile:write scope to your app
• not_authed: Check your token format (should start with xoxp-)
• user_not_found: Verify the user ID is correct
• not_allowed: Ensure you have admin privileges and a paid plan
• invalid_profile: Check JSON format for profile data

• Use single quotes around JSON to avoid shell escaping issues
• Test with your own user ID first
• Use list-fields to see available custom fields
• Check Slack's profile admin settings for API access

MIT