Skip to main content

​
How To Set Up Subscriptions

To add Macroscope to a Slack channel, type @Macroscope. Slack will respond, asking if you want to add @Macroscope into the channel. Click Add Them.Use /macroscope help to see the full list of available subscription commands in Slack.Use /macroscope subscriptions to see a channel’s current subscriptions.
Macroscope can stream real-time code activity summaries directly into Slack channels, via /macroscope commands. This turns Slack into a living dashboard of your engineering activity. Slack channels can be subscribed to specific repositories or specific types of activity, so that each team can see only the updates most relevant to their work. We recommend keeping activity feeds organized by creating dedicated channels for each feed (e.g. #commit-summaries, #pr-activity). To filter notifications by file paths, you can use path-based filters to narrow the scope of the activity that is streamed into Slack.
Macroscope broadcasts the status of pull requests in Slack with emojis - ✅ approved, 💬 commented, 🎉 merged - so everyone can see the latest state of work at a glance.

Centralized Activity Visibility

The engineering team sets up #code-activity to stream all commit and PR activity./macroscope subscribe-commits/macroscope subscribe-prs

Targeted Repository Tracking

The mobile team creates #ios-repo-feed and subscribes it to code activity from their specific iOS repository./macroscope subscribe ios-repo

Lightweight Monitoring of PRs

The PM team wants visibility into feature progress within a certain repository, but doesn’t need full commit firehose.They create a channel called #[new feature name]-prs and subscribe only to PR updates for that specific repository./macroscope subscribe-prs [name of new feature repo]

​
Path-Based Filters

When subscribing Slack channels to code activity, Macroscope lets you filter code activity to specific parts of your repository, based on file paths. This allows different Slack channels to follow distinct areas of the codebase. For example, you may want to subscribe a Slack channel to just code activity from the backend folder of your repo, and subscribe another Slack channel to just the code activity from the frontend/pages folder. 
your-repo/
│── macroscope.md                        
│── backend/
│   ├── ...
│── frontend/
│   ├── ...
│   └── pages/
This is especially useful for teams with large monorepos. To create a code activity subscription that is filtered by file path, add the --paths= flag to the end of a /macroscope command, and specify which file paths you want to filter by. For example:
  • /macroscope subscribe-commits back --paths=/api
  • /macroscope subscribe-prs back --paths=/services
  • /macroscope subscribe-build-failures back --paths=/api
Any code activity that modifies files matching the specified path filter will trigger a Slack notification in the subscribed channel. For example, if you subscribe to pull requests for the frontend directory using /macroscope subscribe-prs your-repo --paths=/frontend, then any new PR that includes changes to files within the frontend folder (including files within any nested subdirectories) will be streamed into that Slack channel. To filter by multiple paths (i.e. to subcribe to activity from several different folders), use a comma-separated list of paths: --paths=/api,/services When a file path has spaces or commas in its name, put the file path name in quotes: --paths="/my folder/api"
Path-based filters are optional. If you don’t include a --paths= filter in a /macroscope subscription command, all activity from the repository will be streamed into the Slack channel.