Start here
You need your own GitHub account and permission to use Peacemaker. Your team lead can help with both.
There are two sign-ins: one to download the project, and one to download its private software package. Follow the steps in order.
Keep secrets private. Enter passwords, tokens, and sign-in codes on your computer. Never paste them into an AI chat.
New words in this guide
- GitHub
- The website that stores our project.
- Repository (repo)
- The project files and their change history.
- Terminal
- A window where you type commands.
- Git and gh
- Git tracks and downloads files. gh connects your terminal to GitHub.
- Clone and pull
- Clone downloads your first copy. Pull gets later updates.
- Token and package
- A token is a secret access key. A package is software the project needs.
1. Get repository access
- Open GitHub. Sign in or create an account with the work details agreed with your team.
- Verify your email. Send your GitHub username to your team lead.
- Ask for access to BranditDev/peacemaker and its required GitHub packages. Accept the GitHub invitation.
- Complete any required company sign-in or two-factor sign-in. Open Peacemaker on GitHub.
Check before you continue: You can see the file list and README.md. If you see “Not Found,” ask the team to check your access. A token cannot grant access your account does not have.
2. Check your tools
On Mac, open Terminal from Applications → Utilities. On Windows, open PowerShell from Start. Copy one command at a time, then press Enter.
git --version gh --version If a command is missing, use your company’s approved installation process. See Git installation and GitHub CLI installation.
Installation commands for Mac and Windows
Mac: If Homebrew is already installed:
brew install git gh Windows: If WinGet is available, run each command:
winget install --id Git.Git -e winget install --id GitHub.cli -e Ask IT for help if installation needs administrator access.
Check before you continue: Reopen the terminal after installation. Both version commands show a version number.
3. Sign in through your browser
Start with browser sign-in. You do not need to create or copy a personal access token for this step.
gh auth login --hostname github.com --git-protocol https --web - If asked whether Git should use your GitHub credentials, choose Yes.
- Follow the terminal instructions to open your browser and enter the one-time code.
- Check the account name. Review and approve the GitHub CLI access request.
- Return to the terminal. Run these commands:
gh auth setup-git gh auth status Check before you continue: The status shows your intended account and says you are logged in.
The setup command lets Git use the sign-in saved by gh. If gh reports plain-text token storage, ask IT to configure secure storage. Sources: CLI sign-in and Git setup.
4. Download Peacemaker
First, check access. This command should show the project details:
gh repo view BranditDev/peacemaker Move to your Documents folder. Then download the project:
cd ~/Documents gh repo clone BranditDev/peacemaker cd peacemaker git status Check before you continue: Your Documents folder contains peacemaker. Git reports no local changes in this new copy. Keep the terminal open.
Already have a copy? Get updates
Use the existing peacemaker folder. Do not delete it. From inside that folder, run:
git pull --ff-only If Git reports conflicts, local changes, or diverged branches, stop and ask for help. Do not discard files.
5. Set up the package token
Peacemaker needs a private GitHub package. Its package manager reads a value called GITHUB_TOKEN. Signing in to gh does not set this value.
- Ask your team to confirm that your account can read the package.
- Open token settings. Choose Generate new token → Generate new token (classic).
- Name it Peacemaker package download. Set an expiry date allowed by your team.
- Select
read:packages. You do not need publish or delete permissions. - Generate the token and save it in your approved password manager. If required, use Configure SSO → Authorize for your organization.
Enter the token in your own terminal. Open the instructions for your system. The paste prompt hides the token.
Mac · default zsh terminal
Run the first command. Paste the token at the prompt and press Enter. Then run the second command.
read -s "GITHUB_TOKEN?Paste your package token, then press Enter: " export GITHUB_TOKEN After package installation, clear the temporary value:
unset GITHUB_TOKEN Windows · PowerShell
Run each command separately. Paste the token when the first command asks for it.
$qaPackageToken = Read-Host "Paste your package token" -AsSecureString $env:GITHUB_TOKEN = [System.Net.NetworkCredential]::new('', $qaPackageToken).Password Remove-Variable qaPackageToken After package installation, clear the temporary value:
Remove-Item Env:GITHUB_TOKEN Use this same terminal for the README’s pnpm install step after installing its prerequisites. A new terminal may need the token again. A .env file alone does not supply this value to the package manager.
Check before you continue: Package installation finishes without an access error. Clear the temporary value before using gh again: GITHUB_TOKEN can override its saved sign-in.
Keep tokens out of source files and .npmrc. Sources: package authentication, token overrides, and SSO authorization.
6. Start with your assistant
Open the downloaded peacemaker folder in Claude Code or your preferred assistant. Give it this message:
I have completed GitHub sign-in on this computer. Check access to BranditDev/peacemaker with gh repo view. Then help me follow the README and run an existing test. If access fails, explain the error. Do not ask me to paste a token into chat or print a saved token.
Your browser, terminal, and a cloud AI session can have separate access. If your assistant runs elsewhere, use its approved GitHub connection or work in the local repository.
Check before you continue: You can view the repository, download it, and install its packages. Continue with the Peacemaker README and its QA workflow guide.
If a tool asks for a token
Skip this if browser sign-in worked. Some tools need a token entered into their own credential field. Ask your team which token type and permissions that tool needs.
Manual token sign-in for GitHub CLI
GitHub documents a classic token with repo, read:org, and gist permissions for this path. The repo permission is broad and can allow writes. Use it only if your organization permits it.
- Open token settings. Select Generate new token (classic).
- Name it QA GitHub CLI, set an expiry date, and select those three permissions.
- Generate it and save it in your approved password manager. Complete SSO authorization if required.
- Run the command below. Choose Paste an authentication token, then paste into the terminal prompt.
gh auth login --hostname github.com --git-protocol https Repeat the sign-in and repository access checks above. A fine-grained token can limit repository access, but support varies by tool.
Sources: CLI token requirements and token types and creation.
Get help
Send your team the command, error text, and GitHub username. Remove secret values first.
| What you see | What to check |
|---|---|
| Command not found | Install Git or gh, then reopen the terminal. |
| Repository not found | Check your account and accepted invitation. |
| Browser works; gh fails | Check gh auth status, token overrides, and organization approval. |
| Token expired or pending | Renew it or ask the administrator to approve it. Update the tool that uses it. |
| Package install: 401 or 403 | Check package access, read:packages, token expiry, and SSO. |
| Terminal works; assistant fails | Check whether both use the same computer and environment. |
If you share a token by mistake, delete it in GitHub token settings and create a replacement.
Documentation checked October 15, 2026. Your organization may have additional access requirements.