Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Set up init

kater init team

Invites people to your organisation and completes the team step.

This is step 6 of kater init. It sends the invitation emails, and skips anyone already invited or already a member.

Examples

Terminal window
# Invite one person as a developer
kater init team teammate@example.com --role developer
# Invite one person as a viewer, into the Marketing group
kater init team teammate@example.com --role viewer --group Marketing
# Invite everyone in a CSV file
kater init team --csv people.csv

Arguments

ArgumentDescription
<emails>Optional. The email addresses of the people to invite, such as teammate@example.com. Leave them out when you give --csv. Give one or more.

Options

OptionDescription
--role <role>The role of the people you name: admin, developer or viewer. Give it when you name people.
--group <group>A group to add the people to, such as Marketing. Kater makes the group when it does not exist. You can give it more than one time.
--csv <file>A CSV file of people to invite, each with their own role, groups and attributes. See The CSV file.
--connection <connection>A connection they can use; repeat for more. The first is their default. Left out, the organisation’s one connection. You can give it more than one time.

It also takes --help.

After the setup

To invite more people later, run kater admin team invite. It takes the same options, and it does not change the progress of the setup. kater admin sso link and kater admin scim request also help you bring people in. It needs the settings:manage permission.

See also