sos login

Authenticate user with signageOS

Description

Handles user authentication using username/email and password credentials. Supports both Auth0 and legacy authentication methods. Stores credentials securely in the ~/.sosrc configuration file for subsequent CLI operations.

Usage

sos login [options]

Options

Option	Type	Description	Default
--username	string	Username or e-mail used for authentication

Examples

# Interactive login (prompts for username and password)
sos login

# Login with username specified
sos login --username user@example.com

# Enable Auth0 authentication
sos login --auth0-enabled

# Enable legacy authentication
sos login --legacy-enabled

Advanced Usage

Configuration Management

Run Control File

Login credentials are stored in ~/.sosrc file. For the default profile, it contains:

identification=xxxxxxxxxxxxxxxxxxxx
apiSecurityToken=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Multiple Profiles

You can manage multiple accounts/configurations using profiles with the SOS_PROFILE environment variable or --profile argument:

# Login with specific profile
sos login --profile production

# Use profile in subsequent commands
sos --profile production applet upload

The configuration file uses INI sections for named profiles:

[profile production]
identification=xxxxxxxxxxxxxxxxxxxx
apiSecurityToken=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

[profile staging]
identification=yyyyyyyyyyyyyyyyyyyy
apiSecurityToken=yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy

Environment Variables

You can override login credentials using environment variables:

• SOS_API_IDENTIFICATION: Override stored identification
• SOS_API_SECURITY_TOKEN: Override stored security token
• SOS_PROFILE: Specify which profile to use

Generate tokens at: https://box.signageos.io/settings

Requirements

• Active account. It can be obtained by manual sign-up in https://box.signageos.io
• Login account credentials are stored in ~/.sosrc file

Since

0.3.0

Global Options

All commands support the following global options:

Option	Alias	Description
--help	-h	Display help information for any command
--version	-v	Display the installed version of the CLI
--api-url	-u	Override the API URL for REST requests
--profile		Use a specific profile from ~/.sosrc config

Examples

# Show version
sos --version

# Get help for any command
sos applet --help
sos applet upload --help

# Use custom API endpoint
sos --api-url https://api.example.com applet upload

# Use specific profile
sos --profile production organization list