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.3.tar.gz (20.0 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.3-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: addteam-0.8.3.tar.gz
  • Upload date:
  • Size: 20.0 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.3.tar.gz
Algorithm Hash digest
SHA256 9f7ada07c34971ec1a2de711589c197ea43d45995a7970db46d0ec1139146760
MD5 c392615329b9ed80975813d306987adb
BLAKE2b-256 92d8e7bbb007e9432cfd4fd317fff4357dffefa0f27bb90ddf042dcdd3e2b5af

See more details on using hashes here.

File details

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

File metadata

  • Download URL: addteam-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 17.5 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bd7f2b87d06476563c51222c3fc196791cf7effa541f55dc37e0e880b2c7b39e
MD5 d9cb4f0de00150a9d32a2c71515eded3
BLAKE2b-256 97fd93edfb442789f3103dd151d96e6952e73071a32d17945fc0a1793d6d1abe

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