Skip to main content

One-command collaborator management for GitHub repos with GitOps support.

Project description

addteam

Invite GitHub collaborators from a simple YAML file.

Install

pip install addteam

Or run without installing:

uvx addteam

Prerequisite: GitHub CLI must be installed and authenticated (gh auth login).

First Run

# In your repo directory, create a team.yaml
addteam --init

# Edit team.yaml with your team members, then run:
addteam

That's it! Your collaborators will be invited.


team.yaml Format

default_permission: push

admins:
  - alice

developers:
  - bob
  - charlie

reviewers:
  - eve

Role names map to permissions automatically:

Role Permission
admins admin
maintainers maintain
developers, contributors push
reviewers, readers pull
triagers triage

Common Commands

addteam                    # invite from local team.yaml
addteam -n                 # dry-run (preview only)
addteam -a                 # audit (show drift)
addteam -s                 # sync (also removes unlisted users)
addteam owner/repo         # use team.yaml from another repo

Central Team Config

Keep one team.yaml in a shared repo, apply it anywhere:

# Anyone on your team can run this in any repo:
uvx addteam myorg/team-config

The AI summary at the end is perfect for sharing via email or Slack.

Options

Flag Description
-n, --dry-run Preview without making changes
-s, --sync Remove collaborators not in list
-a, --audit Show drift without making changes
-r, --repo Target a specific repo
-q, --quiet Minimal output
--no-welcome Skip creating welcome issues
--no-ai Skip AI-generated summaries

GitOps Setup

Automatically sync collaborators when team.yaml changes:

addteam --init --init-action

This creates:

  • team.yaml - your team config
  • .github/workflows/sync-collaborators.yml - runs on push

Add a TEAM_SYNC_TOKEN secret (PAT with repo scope) to your repo.

Advanced Features

Expiring Access

contractors:
  - username: temp-dev
    permission: push
    expires: 2025-06-01

GitHub Teams (orgs)

teams:
  - myorg/backend-team
  - myorg/frontend-team: pull

Multi-Repo Management

addteam --init-multi-repo

Creates repos.txt to sync the same team across multiple repos.

Welcome Issues

New collaborators automatically get a welcome issue with an AI-generated summary of your repo (requires OPENAI_API_KEY, ANTHROPIC_API_KEY, or GOOGLE_API_KEY).

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

addteam-0.8.10.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

addteam-0.8.10-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

Details for the file addteam-0.8.10.tar.gz.

File metadata

  • Download URL: addteam-0.8.10.tar.gz
  • Upload date:
  • Size: 22.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for addteam-0.8.10.tar.gz
Algorithm Hash digest
SHA256 720f6db6582876b6f882bef497299a5d41d7c82aa6ff8f5ef6a1e786c00317f9
MD5 060fbcf0f4ff09e289c0392f709ff9cf
BLAKE2b-256 79a49f61372f0cc94b4c2e97b40896e99aa601d242adc8947789ea94b26d8366

See more details on using hashes here.

File details

Details for the file addteam-0.8.10-py3-none-any.whl.

File metadata

  • Download URL: addteam-0.8.10-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for addteam-0.8.10-py3-none-any.whl
Algorithm Hash digest
SHA256 8fa8c347b00f96fd1d531a9db49adcdfba2e0465e46dd7a5000222920eaa6cda
MD5 db0c8060a04e7e6dc2de53c3acff8218
BLAKE2b-256 2c68cb1d7f43c74b87b3b6356ccb4ba8c993c7e9cb34e3e3b577493b105e22d6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page