Skip to main content

CLI Reference

Generated from the binary

This reference is generated from teams --help-json for release v0.1.0. The generated command pages are replaced on each CLI release.

OSO MS Teams CLI is installed as teams. It defaults to human output in an interactive terminal and JSON when stdout is piped. Use --output json when an agent or script needs a stable envelope.

Global Options

OptionPurpose
`-o, --output jsonhuman
-q, --quietSuppress non-essential output.
-v, --verboseIncrease stderr logging. Repeat for debug or trace.
--no-colorDisable ANSI colors.
--config <path>Use an explicit config file.
--profile <name>Use a named credential profile.
--timeout <seconds>Override Graph request timeout.
--retry <count>Override retry attempts.
--page-size <count>Set page size for list operations.
--all-pagesFollow Graph pagination until complete.

Commands

CommandSummary
teams authAuthentication commands.
teams auth loginAuthenticate with delegated auth, device code, or client credentials.
teams auth statusCheck whether the selected profile is authenticated.
teams auth consent-urlPrint an admin consent URL for the active delegated app.
teams auth doctorDiagnose profile auth configuration and token claims.
teams auth listList authenticated profiles.
teams auth switchSwitch the active profile.
teams auth logoutClear stored credentials.
teams auth tokenExport the current access token.
teams userUser lookup commands.
teams user meGet the current authenticated user profile.
teams user getGet a user by ID or user principal name.
teams user listList users in the organization.
teams configConfiguration management.
teams config initInitialize config file with defaults.
teams config showShow current configuration.
teams config getGet a config value.
teams config setSet a config value.
teams config pathPrint config file location.
teams config profilesList all profiles.
teams completionsGenerate shell completions.
teams teamTeam operations.
teams team listList joined teams.
teams team getGet a team by ID.
teams team createCreate a new team.
teams team updateUpdate a team.
teams team deleteDelete a team.
teams team cloneClone a team.
teams team archiveArchive a team.
teams team unarchiveUnarchive a team.
teams team membersTeam member operations.
teams team members listList team members.
teams team members addAdd a member to a team.
teams team members removeRemove a member from a team.
teams channelChannel operations.
teams channel listList channels in a team.
teams channel getGet a channel by ID.
teams channel createCreate a new channel.
teams channel updateUpdate a channel.
teams channel deleteDelete a channel.
teams channel membersChannel member operations.
teams channel members listList channel members.
teams channel members addAdd a channel member.
teams channel members removeRemove a channel member.
teams messageMessage operations.
teams message sendSend a message to a channel or chat.
teams message listList messages in a channel or chat.
teams message getGet a specific message.
teams message replyReply to a channel message.
teams message reactAdd a reaction to a message.
teams message unreactRemove a reaction from a message.
teams message pinPin a message in a channel.
teams message unpinUnpin a message in a channel.
teams message deleteDelete a message.
teams message updateUpdate a message.
teams chatChat operations.
teams chat listList chats.
teams chat getGet a chat by ID.
teams chat createCreate a chat.
teams chat updateUpdate a chat topic.
teams chat hideHide a chat.
teams chat unhideUnhide a chat.
teams chat membersChat member operations.
teams chat members listList chat members.
teams chat members addAdd a chat member.
teams chat members removeRemove a chat member.
teams presencePresence status operations.
teams presence getGet presence status.
teams presence get-batchGet presence for multiple users.
teams presence setSet your presence status.
teams presence statusSet your status message.
teams presence clearClear your presence.
teams searchSearch messages, users, and teams.
teams search messagesSearch messages.
teams search usersSearch users.
teams search teamsSearch joined teams by display name.
teams tagTag operations for teams.
teams tag listList tags in a team.
teams tag getGet a tag by ID.
teams tag createCreate a tag.
teams tag updateUpdate a tag.
teams tag deleteDelete a tag.
teams tag add-memberAdd a member to a tag.
teams tag remove-memberRemove a member from a tag.
teams meetingOnline meeting operations.
teams meeting listList online meetings created by you.
teams meeting getGet a meeting by ID.
teams meeting createCreate an online meeting.
teams meeting updateUpdate a meeting.
teams meeting deleteDelete a meeting.
teams meeting join-urlGet the join URL for a meeting.
teams meeting attendanceList attendance reports for a meeting.
teams notifySend activity notifications.
teams notify sendSend activity notification to users.
teams notify send-to-teamSend activity notification to a team.
teams notify send-to-chatSend activity notification to a chat.
teams appInstalled app operations.
teams app listList installed apps in a team.
teams app installInstall an app in a team.
teams app uninstallUninstall an app from a team.
teams tabChannel tab operations.
teams tab listList tabs in a channel.
teams tab createCreate a tab in a channel.
teams tab deleteDelete a tab from a channel.
teams fileFile operations for channels.
teams file listList files in a channel.
teams file getGet file metadata.
teams file uploadUpload a file to a channel.
teams file downloadDownload a file from a channel.
teams file deleteDelete a file from a channel.
teams file shareCreate a sharing link for a file.
teams subscribeSubscription operations for change notifications.
teams subscribe createCreate a new subscription.
teams subscribe listList active subscriptions.
teams subscribe renewRenew a subscription.
teams subscribe deleteDelete a subscription.
teams listenStart a webhook listener for change notifications.

Output Contract

See JSON envelope and exit codes for the agent-facing contract.