Skip to content

docs(cli-auth): added programmatic auth command for Dyte CLI #442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 13, 2025
Merged

docs(cli-auth): added programmatic auth command for Dyte CLI #442

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
719bad9
docs(cli-auth): added programmatic auth command for Dyte CLI
ravindra-dyte May 5, 2025
8c445be
docs(cli): improved wording around programmatic authorisation
ravindra-dyte May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/cli/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The Dyte CLI needs a little bit of work to get started. We're working on
reducing the amount of effort required, but for now you'll have to do the
following.

## Configuration
## Manual Configuration

1. Authorize yourself with the Dyte Dev Portal. This allows you to access all
the organizations that you belong to from the CLI.
Expand All @@ -26,6 +26,18 @@ dyte auth login
dyte auth org
```

## Programmatic Configuration

If browser-based authorization via `dyte auth login` is not suitable, you can alternatively authorize the Dyte CLI programmatically using the following command:

```bash
dyte config creds --org-id YOUR_DYTE_ORG_ID --api-key API_KEY_OF_THE_ORG
```

This method is especially beneficial for automating workflows, such as integrating CI/CD pipelines in custom plugin development.

Note that this is an organization-specific authorization. As a result, commands like dyte auth org will not function. However, you can still perform organization-specific operations, including publishing plugins and creating meetings.

## Usage

### General
Expand Down
Loading