CLI Reference

Generated reference

This reference is generated from checked-in CLI metadata for release v0.9.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

Option	Purpose
-o, --output json|human|plain	Force output format.
-q, --quiet	Suppress non-essential output.
-v, --verbose	Increase stderr logging. Repeat for debug or trace.
--no-color	Disable 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 whose Graph endpoint accepts $top.
--all-pages	Follow Graph pagination until complete.
-h, --help	Print command help.
-V, --version	Print the CLI version.

Commands

Command	Summary
teams auth	Authentication commands
teams auth login	Authenticate with Microsoft Teams
teams auth refresh	Silently redeem the stored refresh token for the resolved delegated scopes
teams auth status	Check current auth status
teams auth consent-url	Print the admin consent URL for the active auth app
teams auth doctor	Diagnose auth configuration and current token state
teams auth list	List stored profiles and the account each one holds
teams auth switch	Switch active profile
teams auth logout	Clear stored credentials
teams auth token	Export current access token
teams user	User lookup commands
teams user me	Get current authenticated user's profile
teams user get	Get a user by ID or UPN
teams user list	List users in the organization
teams user resolve	Resolve a name or email to user candidates, degrading with available scopes: exact lookup, then people search, then a roster sweep over shared group/meeting chats
teams config	Configuration management
teams config init	Initialise config file with defaults
teams config show	Show current configuration
teams config get	Get a config value
teams config set	Set a config value
teams config path	Print config file location
teams config profiles	List all profiles
teams completions	Generate shell completions
teams team	Team operations
teams team list	List joined teams
teams team get	Get a team by ID
teams team create	Create a new team
teams team update	Update a team
teams team delete	Delete a team
teams team clone	Clone a team
teams team archive	Archive a team
teams team unarchive	Unarchive a team
teams team members	Team member operations
teams team members list	List team members
teams team members add	Add a member to a team
teams team members remove	Remove a member from a team
teams channel	Channel operations
teams channel list	List channels in a team
teams channel get	Get a channel by ID
teams channel create	Create a new channel
teams channel update	Update a channel
teams channel delete	Delete a channel
teams channel members	Channel member operations
teams channel members list	List channel members
teams channel members add	Add a member to a channel
teams channel members remove	Remove a member from a channel
teams message	Message operations
teams message send	Send a message to a channel or chat
teams message list	List messages in a channel or chat
teams message get	Get a specific message
teams message attachments	List or download message attachments and inline images
teams message attachments list	List attachments and inline images in a message
teams message attachments download	Download attachments and inline images from a message
teams message reply	Reply to a channel message
teams message react	Add a reaction to a channel or chat message
teams message unreact	Remove a reaction from a channel or chat message
teams message pin	Pin a message in a channel
teams message unpin	Unpin a message from a channel
teams message delete	Delete your own message (a soft delete; undo it with message undelete)
teams message undelete	Restore a message removed with message delete
teams message update	Update a message
teams chat	Chat operations
teams chat list	List your chats
teams chat get	Get a chat by ID
teams chat create	Create a new chat
teams chat update	Update a chat topic
teams chat hide	Hide a chat
teams chat unhide	Unhide a chat
teams chat members	Chat member operations
teams chat members list	List chat members
teams chat members add	Add a member to a chat
teams chat members remove	Remove a member from a chat
teams presence	Presence status operations
teams presence get	Get presence status (yours or another user's)
teams presence get-batch	Get presence for multiple users
teams presence set	Set your presence status
teams presence set-preferred	Set your preferred presence, which overrides every session's status while one exists
teams presence status	Set your status message
teams presence clear	Clear your presence (revert to automatic)
teams presence clear-preferred	Clear your preferred presence, so the sessions' status shows again
teams search	Search messages, users, and teams
teams search messages	Search messages
teams search users	Search users (people)
teams search teams	Search your joined teams by display name
teams tag	Tag operations for teams
teams tag list	List tags in a team
teams tag get	Get a tag by ID
teams tag create	Create a tag
teams tag update	Update a tag
teams tag delete	Delete a tag
teams tag add-member	Add a member to a tag
teams tag remove-member	Remove a member from a tag
teams meeting	Online meeting operations
teams meeting list	List online meetings created by you
teams meeting get	Get a meeting by ID
teams meeting create	Create an online meeting
teams meeting update	Update a meeting
teams meeting delete	Delete a meeting
teams meeting join-url	Get the join URL for a meeting
teams meeting attendance	List attendance reports for a meeting
teams notify	Send activity notifications
teams notify send	Send activity notification to user(s)
teams notify send-to-team	Send activity notification to a team
teams notify send-to-chat	Send activity notification to a chat
teams app	Installed app operations
teams app list	List installed apps in a team
teams app install	Install an app in a team
teams app uninstall	Uninstall an app from a team
teams tab	Channel tab operations
teams tab list	List tabs in a channel
teams tab create	Create a tab in a channel
teams tab delete	Delete a tab from a channel
teams file	File operations for channels
teams file list	List files in a channel
teams file get	Get file metadata
teams file upload	Upload a file to a channel
teams file download	Download a file from a channel
teams file delete	Delete a file from a channel
teams file share	Create a sharing link for a file
teams subscribe	Subscription operations for change notifications
teams subscribe create	Create a new subscription
teams subscribe list	List active subscriptions
teams subscribe renew	Renew a subscription
teams subscribe delete	Delete a subscription
teams listen	Start a webhook listener for change notifications

Output Contract

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