Skip to content

ph org ​

Organizations: list, current, switch, create, rename, leave, github, invite, invites, members, domain, export (your data), delete

This page is generated from ph org --help by npm run gen in site/, so do not edit it by hand.

text
Usage: ph org <command>

Organizations (a login and a token belong to one organization; ph org switch changes which one Phillip uses) ​

list ​

text
list [--json]                            Organizations I belong to; the current one is marked *

current ​

text
current [--json]                         The current organization, my role, plan and seats

switch ​

text
switch <slug>                            Use another organization (logs in with the browser if this machine has no token for it yet)

create ​

text
create <slug> [--name <name>] [--json]   Create an organization (needs a browser login); you become its owner, then it becomes current

rename ​

text
rename <name>                            Rename the current organization (owner or admin; the slug cannot change)

leave ​

text
leave [--yes]                            Leave the current organization (the last owner cannot leave)

setup ​

text
setup [--json]                           Setup checklist with real status (same as the Portal): connect_github, create_project, standard_labels,
                                         invite_team, first_telemetry, first_review

labels ​

text
labels [show] [--json]                   The label mapping: which of your own labels (bug, in progress...) mean a status, type or level.
                                         Nothing is written to your repositories; the mapping is applied when issues are read

labels suggest ​

text
labels suggest [--json]                  Scan the labels of your projects' repositories and suggest a mapping (owner or admin)

labels set ​

text
labels set --file <json> [--confirm]     Replace the whole mapping from a file (a map, or the output of suggest --json; - reads stdin).
                                         Owner or admin. --confirm also confirms it (finishes the setup step)

labels confirm ​

text
labels confirm                           Confirm the current mapping

labels create ​

text
labels create <name> --for <status|type|level>=<value> [--color hex] [--repo owner/repo]... [--json]
                                         Create a label that your repositories lack (for example "status: approved" --for status=approved) on
                                         every repository of your projects, or only on the --repo ones, and add it to the mapping as a draft.
                                         Owner or admin, login session. GitHub needs Issues: write on the app; GitLab needs a token with the api scope

setup skip ​

text
setup skip <step>                        Skip a step (owner or admin, needs a login session)

setup dismiss ​

text
setup dismiss                            Hide the guide for the whole organization (owner or admin, needs a login session)

People (owner or admin invite and manage) ​

invite ​

text
invite <email> [--role member|viewer|admin]
                                         Invite by email (single use, only the holder of that address can accept)

invite (2) ​

text
invite --link [--role ...] [--max-uses <n>] [--expires 7d]
                                         Create an invitation link; the address is shown once, keep it. Default role: member,
                                         1 use, 7 days (at most 90)

invites ​

text
invites [list] [--json]                  Invitations that were not revoked, with status and uses

invites revoke ​

text
invites revoke <id>                      Revoke an invitation

members ​

text
members [list] [--json]                  Members and roles (emails are shown to owners and admins only)

members set-role ​

text
members set-role <login> <owner|admin|member|viewer>
                                         Change a role (only an owner grants or revokes owner; the last owner cannot be demoted)

members remove ​

text
members remove <login>                   Remove a member

GitHub (connect your GitHub organization; owner or admin change it, from a login session) ​

github ​

text
github [--json]                          Connection status: account, auto-join role, repositories, people skipped for lack of a seat

github connect ​

text
github connect [--no-browser]            Print the GitHub install address and open it. GitHub brings you back to the Portal when done

github auto-join ​

text
github auto-join <off|viewer|member>     Let members of the GitHub organization join this organization when they sign in with GitHub
                                         (never admin or owner); they are removed again when they leave the GitHub organization

github sync ​

text
github sync                              Refresh repositories and GitHub members now (also done every hour)
text
github unlink [--yes]                    Disconnect GitHub (people who joined through it stay as manual members)

GitLab (connect a GitLab group, gitlab.com or a self-managed host the server allows; owner or admin, from a login session) ​

gitlab ​

text
gitlab [status] [--json]                 Status: host, group, credential, auto-join role, webhook, people skipped for lack of a seat

gitlab connect ​

text
gitlab connect [--host <url>] [--group <path>] [--no-browser]
                                         Sign in to GitLab in the browser (OAuth), then choose the group. Default host https://gitlab.com

gitlab connect (2) ​

text
gitlab connect --token-stdin --group <path> [--host <url>]
                                         Connect with a Group/Project Access Token or a bot PAT (read_api) read from stdin, never from arguments

gitlab group ​

text
gitlab group <path>                      Choose the group of a connection that is waiting for it (full path, subgroups included)

gitlab auto-join ​

text
gitlab auto-join <on|off|viewer|member>  Let members of the GitLab group join this organization when they sign in with GitLab (on = member;
                                         never admin or owner); they are removed again when they leave the group

gitlab sync ​

text
gitlab sync                              Reconcile group members now (also done every hour)

gitlab webhook ​

text
gitlab webhook [--rotate] [--json]       Show the webhook URL; --rotate creates a new secret, shown once
text
gitlab unlink [--yes]                    Disconnect GitLab (people who joined through it stay as manual members)

Email domains (owner or admin; people with a verified email on a verified domain can join on their own) ​

domain ​

text
domain [list] [--json]                   Domains with status and auto-join; pending ones show the TXT record to create

domain add ​

text
domain add <domain>                      Add a domain and print the TXT record that proves you own it

domain verify ​

text
domain verify <domain>                   Check the TXT record and verify the domain

domain auto-join ​

text
domain auto-join <domain> <off|viewer|member>
                                         Role given to people who join by email domain (off disables it; the domain must be verified)

domain remove ​

text
domain remove <domain> [--yes]           Remove a domain
text
Device enrollment tokens (owner or admin, from a login session; for Guardrails MDM packages: a managed machine loads this organization's

policies with the token before anyone has signed in. It can only read the policy list and policy packages) ​

device-token ​

text
device-token [list] [--json]             Active tokens: name, prefix, who created it, expiry, last used (values are never shown again)

device-token create ​

text
device-token create <name> [--days <n>] [--out <file>]
                                         Create a token (default 365 days, max 730). Prints the secret once, or with --out writes it to <file>
                                         (mode 600) as TARA_DEVICE_ORG=... and TARA_DEVICE_TOKEN=... for deploy/guardrails-mdm/build.sh
                                         --device-token-file, and prints nothing secret

device-token revoke ​

text
device-token revoke <id> [--yes]         Revoke a token (machines keep the last verified policy until they can't refresh it)

SCIM 2.0 provisioning (owner only, from a login session; your identity provider, e.g. Okta or Entra ID, creates and removes people and groups) ​

scim-token ​

text
scim-token [list] [--json]               Active SCIM tokens: name, prefix, who created it, expiry, last used, and the SCIM base URL

scim-token create ​

text
scim-token create <name> [--days <n>] [--out <file>]
                                         Create a token. Prints the base URL and secret once, or with --out writes SCIM_BASE_URL=... and
                                         SCIM_TOKEN=... to <file> (mode 600) and prints nothing secret

scim-token revoke ​

text
scim-token revoke <id> [--yes]           Revoke a token (the identity provider stops syncing)

scim-roles ​

text
scim-roles [--json]                      Show which organization role each SCIM group gets (people in several groups get the highest)

scim-roles set '<json>' ​

text
scim-roles set '<json>' | --file <path>  Replace the whole mapping, e.g. '{"Engineering":"member","Platform":"admin","Stakeholders":"viewer"}'
                                         (roles: admin, member, viewer; SCIM never grants owner). '{}' clears it

Data export (owner only, from a login session; one export every 24 hours; the file is kept 7 days) ​

export ​

text
export [--wait] [-o <file.zip>] [--json]
                                         Ask for an export of everything Tara holds about the organization (JSON files: organization, members,
                                         invites, projects, tracker settings, resources, Guardrails policy declarations, audit log, billing summary,
                                         device token metadata; plus tasks, weekly Flow and AI cost, and sessions from Ryoma). No tokens, secrets,
                                         package contents or prompts. --wait waits until it is ready; -o also saves it (implies --wait)

export list ​

text
export list [--json]                     Recent exports and their state

export download ​

text
export download <id> [-o <file.zip>]     Download a ready export

Delete the organization (owner only, from a login session) ​

delete ​

text
delete [--confirm <slug>]                Ask to delete the organization. You type its slug again to confirm. It becomes read-only
                                         (every API answers 423), the paid plan ends at the end of the period, and everything is deleted for
                                         good after the waiting period. Export your data first: ph org export

delete (2) ​

text
delete --status [--json]                 Is a deletion pending, and when does the real deletion run

delete (3) ​

text
delete --cancel                          Restore the organization during the waiting period

Single sign-on (OIDC; owner or admin, from a login session; the client secret is stored encrypted and never shown) ​

sso ​

text
sso [--json]                             Status: issuer, client id, role for new people, test result, enforcement, callback URL

sso set ​

text
sso set [--issuer <url>] [--client-id <id>] [--client-secret-stdin] [--jit-role viewer|member|none]
        [--scopes a,b] [--claim-login <c>] [--claim-email <c>] [--claim-name <c>] [--enable|--disable]
                                         Create or change the configuration (the first time needs --issuer, --client-id and the secret on
                                         stdin). Tara fetches the provider's configuration first and saves nothing if it fails

sso test ​

text
sso test                                 Check the saved configuration against the provider; needed before enforcement

sso enforce ​

text
sso enforce <on|off>                     Require SSO for people whose verified email is on a verified domain (owners are exempt)

sso remove ​

text
sso remove [--yes]                       Remove the configuration

Sign in through your provider: ph login ​

text
Sign in through your provider: ph login --sso <org>
text
Roles: owner, admin, member (use Phillip and publish resources), viewer (browser only: BA, PO, PM; takes no seat).
The Free plan has 7 seats (owner, admin, member); viewers are free.
CI: PHILLIP_ORG picks the organization without changing the saved one; PHILLIP_TARA_TOKEN is the token.