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

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.2.tar.gz (19.9 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.2-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: addteam-0.8.2.tar.gz
  • Upload date:
  • Size: 19.9 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.2.tar.gz
Algorithm Hash digest
SHA256 c16d69c0b4fa6a292dc34afb03e57488870124749fd199acbe23b6dd55c92b90
MD5 5b30f2402fafc395eac7b6136157453e
BLAKE2b-256 c275f4eb2d168a75433565183cbc0a98b81c6781d9efe9bca6e626b28e0419b6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: addteam-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 17.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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3a942817033ca4cc21b40319f6fce631956c018c53b19483423eec6f3d527791
MD5 14dedd72612507c8c3d5d8335f9306d6
BLAKE2b-256 66be3a9ef5025957130e8eb522d6cc2e160757917ece0aeb46212343e4668c28

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