Skip to content

feat: add OAuth login command with PKCE flow #93

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
birme merged 2 commits into from
Jan 28, 2026
Merged

feat: add OAuth login command with PKCE flow #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64d80cc
feat: add OAuth login command with PKCE flow and auto-prompt
birme Jan 28, 2026
44ab9ae
fix: remove inferrable type annotations to pass eslint
birme Jan 28, 2026
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
284 changes: 221 additions & 63 deletions packages/cli/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,62 +5,86 @@ CLI for working and scripting with [Open Source Cloud](www.osaas.io)
Prerequisites:

- Node >18
- An Open Source Cloud account and a Personal Access Token at hand
- An Open Source Cloud account

## Install

```
npm install -g @osaas/cli
```

## Authentication

You can authenticate with Open Source Cloud in two ways:

### Option 1: Login via browser (recommended)

Run the `login` command to authenticate using your browser. The token is saved to `~/.osc` and used automatically for subsequent commands.

```
% osc login
Opening browser for login...
Login successful! Token saved to ~/.osc
```

When using a non-production environment:

```
% osc --env dev login
```

### Option 2: Personal Access Token

Set the environment variable `OSC_ACCESS_TOKEN` with your personal access token. Obtain the personal access token in the Eyevinn Open Source Cloud web console.

```
% export OSC_ACCESS_TOKEN=<personal-access-token>
```

### Auto-prompt

If neither a saved token nor `OSC_ACCESS_TOKEN` is found when running a command, the CLI will prompt you to login interactively.

## Usage

```
% osc
Usage: osc [options] [command]

Options:
-v, --version Output the current version
--env <environment> Environment to use
-h, --help display help for command
-v, --version Output the current version
--env <environment> Environment to use
-h, --help display help for command

Commands:
admin Administrative commands for OSC super admins
list <serviceId> List all my service instances
create [options] <serviceId> <name> Create a service instance
describe <serviceId> <name> Get details for a service instance
remove [options] <serviceId> <name> Remove a service instance
restart <serviceId> <name> Restart a service instance
logs <serviceId> <name> Get logs for a service instance
list-reserved-nodes List all my reserved nodes
service-access-token <serviceId> Generate a service access token for a service
secrets Manage secrets for services (list, create, update, remove)
packager [options] <source> <dest> Create streaming package from ABR bundle on S3
and store on another S3 bucket
compare vmaf <reference> <distorted> <result> Compare two video files using VMAF
live Live streaming commands
intercom Intercom messaging commands
transcribe [options] <source> Generate subtitles from video or audio using OpenAI Whisper
db Database management commands
architect AI chat assistant for architecture guidance
vod create [options] <name> <source> Create a VOD file ready for streaming
vod cleanup <name> Remove VOD pipeline but keep VOD files
web publish [options] <name> <dir> Publish a website
web cdn-create [options] <serviceId> <instanceName> Create a CDN distribution
web config-create <name> Create a configuration service instance
web config-delete [options] <name> Delete a configuration service instance
web config-to-env <name> Export configuration values as environment variables
help [command] display help for command
login Login to Open Source Cloud using OAuth
admin Administrative commands for OSC super admins
list <serviceId> List all my service instances
create [options] <serviceId> <name> Create a service instance
describe <serviceId> <name> Get details for a service instance
remove [options] <serviceId> <name> Remove a service instance
logs <serviceId> <name> Get logs for a service instance
restart <serviceId> <name> Restart a service instance
get-instance-replicas <serviceId> <name> Get the number of replicas for a service instance
set-instance-replicas <serviceId> <name> <n> Set the number of replicas for a service instance
service-access-token <serviceId> Generate a service access token for a service
list-reserved-nodes List all my reserved nodes
secrets Manage secrets for services (list, create, update, remove)
packager [options] <source> <dest> Create streaming package from ABR bundle on S3
compare vmaf [options] <reference> <distorted> <result>
Compare two video files using VMAF
live Live streaming commands
intercom Intercom messaging commands
transcribe [options] <source> Generate subtitles from video or audio using OpenAI Whisper
db Database management commands
architect AI chat assistant for architecture guidance
vod VOD transcoding and packaging commands
web Web publishing and configuration commands
help [command] display help for command
```

## Examples

First set the environment variable `OSC_ACCESS_TOKEN` with your personal access token. Obtain the personal access token in the Eyevinn Open Source Cloud web console.

```
% export OSC_ACCESS_TOKEN=<personal-access-token>
```

### Create a MinIO storage service and bucket

Create a MinIO storage server instance called `mystore` with the given credentials.
Expand Down Expand Up @@ -141,6 +165,50 @@ Setup CDN property in AWS Cloudfront
Are you sure you want to remove mystore? (yes/no) yes
```

### Create a service instance with safe name option

Create a service instance with invalid characters stripped from the name:

```bash
% osc create minio-minio "my store with spaces!" --safe-name -o RootUser=admin -o RootPassword=abC12345678
```

### Instance replica management

Get the number of replicas for a service instance:

```bash
% osc get-instance-replicas minio-minio mystore
Instance mystore has 1 actual replicas and 1 desired replicas.
```

Set the number of replicas:

```bash
% osc set-instance-replicas minio-minio mystore 3
Set desired replicas for instance mystore to 3.
```

### Service instance management

Restart a service instance:

```bash
% osc restart minio-minio mystore
```

List your reserved nodes:

```bash
% osc list-reserved-nodes
```

Generate a service access token:

```bash
% osc service-access-token minio-minio
```

### Create ABR file for VOD using SVT Encore

Create a VOD file for streaming from using a pipeline named `demo`. Follow the steps in the [Eyevinn Open Source Cloud documentation](https://docs.osaas.io/osaas.wiki/Solution%3A-VOD-Transcoding.html#vod-transcoding-and-packaging) on how to setup a pipeline.
Expand All @@ -161,47 +229,91 @@ Remove a VOD pipeline but keep the VOD files:
% osc vod cleanup demo
```

### List all channel-engine instance for tenant `eyevinn` as an OSC super admin
### Live streaming

Start a single bitrate live stream:

```bash
% osc live start-single mystreamname
Start streaming to rtmp://... and watch at https://...
```
PAT_SECRET=<pat-secret> osc admin list-instances eyevinn channel-engine

Stop and remove a single bitrate live stream:

```bash
% osc live stop-single mystreamname
```

### Remove a channel-engine instance in dev env for tenant `asdasd` as an OSC super admin
List all single bitrate live streams:

```bash
% osc live list-single
```
PAT_SECRET=<pat-secret> osc --env dev admin remove-instance asdasd channel-engine mychannel

Create and start a multi bitrate live stream:

```bash
% osc live create-multi mystreamname
```

Start an existing multi bitrate live stream:

```bash
% osc live start-multi mystreamname
```

Stop a multi bitrate live stream:

```bash
% osc live stop-multi mystreamname
```

### Create application configuration service instance
### Database management

To manage configuration values for an application we can create an instance of an Application Config Service.
Create a Valkey database:

```bash
% osc web config-create jonastest
Configuration service instance available at https://eyevinnlab-jonastest.eyevinn-app-config-svc.auto.prod.osaas.io
% osc db create valkey mydb
```

And to remove it (with the data)
List all databases of a given type:

```bash
% osc web config-delete --data jonastest
% osc db list valkey
```

### Store application configuration values as environment variables
Remove a database:

Configuration values managed by the Application Config Service can be stored as environment variable using this commmand.
```bash
% osc db remove valkey mydb
```

### Intercom

List productions in an intercom system:

```bash
% osc web config-to-env <config-instance-name>
export AWS_ACCESS_KEY_ID=admin
export CHANNELURL=https://eyevinnlab.ce.prod.osaas.io/channels/mychannel/master.m3u8
% osc intercom list-productions myintercom
```

And storing it in the shell.
Create a production with lines:

```bash
% eval `osc web config-to-env <config-instance-name>`
% osc intercom create-production myintercom "My Production" line1 line2
```

Delete a production:

```bash
% osc intercom delete-production myintercom <productionId>
```

### AI architect chat

Start an interactive chat session with the AI assistant:

```bash
% osc architect chat
```

### Compare video files using VMAF
Expand All @@ -212,6 +324,15 @@ Compare two video files and get a VMAF quality score:
% osc compare vmaf s3://bucket/reference.mp4 s3://bucket/distorted.mp4 s3://bucket/vmaf-result.json
```

Custom AWS credentials and S3 endpoint can be provided:

```bash
% osc compare vmaf \
--aws-access-key-id=AKID --aws-secret-access-key=SECRET \
--s3-endpoint-url=https://s3.example.com \
s3://bucket/reference.mp4 s3://bucket/distorted.mp4 s3://bucket/vmaf-result.json
```

### Generate subtitles from video or audio

Generate subtitles using OpenAI Whisper:
Expand All @@ -221,6 +342,14 @@ Generate subtitles using OpenAI Whisper:
% osc transcribe https://example.com/video.mp4 --format vtt --language en
```

### Create streaming package

Create a streaming package from an ABR bundle on S3:

```bash
% osc packager -v video_1.mp4 video_2.mp4 -a audio.mp4 s3://source-bucket/abr s3://dest-bucket/package
```

### Manage service secrets

List secrets for a service:
Expand All @@ -247,30 +376,59 @@ Remove a secret:
% osc secrets remove minio-minio mysecret
```

### Service instance management
### Web publishing and configuration

Restart a service instance:
Publish a website:

```bash
% osc restart minio-minio mystore
% osc web publish mysite ./dist
```

List your reserved nodes:
Create a CDN distribution:

```bash
% osc list-reserved-nodes
% osc web cdn-create --provider=cloudfront --origin-path=/mybucket minio-minio mystore
```

Generate a service access token:
### Application configuration service

Create a configuration service instance:

```bash
% osc service-access-token minio-minio
% osc web config-create jonastest
Configuration service instance available at https://eyevinnlab-jonastest.eyevinn-app-config-svc.auto.prod.osaas.io
```

### Create a service instance with safe name option
And to remove it (with the data):

Create a service instance with invalid characters stripped from the name:
```bash
% osc web config-delete --data jonastest
```

Store application configuration values as environment variables:

```bash
% osc create minio-minio "my store with spaces!" --safe-name -o RootUser=admin -o RootPassword=abC12345678
% osc web config-to-env <config-instance-name>
export AWS_ACCESS_KEY_ID=admin
export CHANNELURL=https://eyevinnlab.ce.prod.osaas.io/channels/mychannel/master.m3u8
```

And storing it in the shell:

```bash
% eval `osc web config-to-env <config-instance-name>`
```

### Admin commands

List all channel-engine instance for tenant `eyevinn` as an OSC super admin:

```
PAT_SECRET=<pat-secret> osc admin list-instances eyevinn channel-engine
```

Remove a channel-engine instance in dev env for tenant `asdasd` as an OSC super admin:

```
PAT_SECRET=<pat-secret> osc --env dev admin remove-instance asdasd channel-engine mychannel
```
Loading