Skip to content

shellroom join

The shellroom join command allows a user to join an existing training session that has previously been started using shellroom start.

Note

You do not need to run shellroom join in the standard setup, where it will be automatically run after a user logs in.

Example usage

sh
# Join as a participant with your current system user
shellroom join

# Join as a trainer
shellroom join --as-trainer

Flags

FlagDescription
-a, --as-trainerJoin the session with the trainer role
--nameJoin with a username different from the current system user
--second-instanceJoin with a second instance for the same user. Only valid for trainers

--as-trainer

This flag lets you join the training session as a trainer rather than a participant. Trainers have additional privileges, such as observing participant activity and providing help.

By default, shellroom join connects you as a participant.

--name

Overrides the default username when joining a session.
Normally, shellroom join uses your current system username. With --name, you can join as a different user:

shellroom join --name bob