Getting Started

OSC Command lets you run OSC CLI commands as an OSC job — a short-lived service instance that executes a command against the platform and then exits. It is useful for orchestrating other OSC services, automating one-off operations, and running maintenance scripts without a local development environment.

Prerequisites

  • If you have not already done so, sign up for an Eyevinn OSC account
  • An OSC Personal Access Token (PAT) — find yours under Profile → Access Tokens

Step 1: Store your OSC access token as a secret

Navigate to the OSC Command service page, go to the Service Secrets tab, and click New Secret. Enter a name such as osctoken and paste your OSC PAT as the value.

Step 2: Create an OSC Command instance

Click Create osaas-client-ts and fill in:

  • Name: a unique name for this job (alphanumeric only, e.g. myjob)
  • CmdLineArgs: the CLI arguments to pass to the OSC command (e.g. list services)
  • OscAccessToken: {{secrets.osctoken}} (references the secret created in Step 1)

Optionally, if your command needs to read from or write to AWS S3:

  • AwsAccessKeyId: your AWS access key ID
  • AwsSecretAccessKey: your AWS secret access key (store this as a secret and reference it with {{secrets.name}})

Click Create. The job runs once and exits. Check the instance logs to see the command output.

Example commands

List all running service instances:

osc list instances

Create a service instance:

osc create encore myjob

Delete a service instance:

osc delete encore myjob

Refer to the OSC CLI documentation for the full list of available commands.

CLI usage

osc create eyevinn-osaas-client-ts myjob \
  -o CmdLineArgs="list instances" \
  -o OscAccessToken="{{secrets.osctoken}}"

Resources