milesoft settings

Manage system configurations and settings buckets under settings.

The Milesoft CLI allows you to view and modify settings buckets for the active application context:

  • settings app: Manages your app's settings in the Identity Module
  • settings contacts: Manages your app's settings in the Contacts Graph
  • settings notifications: Manages your app's settings in the Notification Engine
  • settings games: Manages your app's settings in the Games Engine

milesoft settings app

Retrieve and update configuration settings associated with the current active application in the Identity Module.

  • get (Retrieve current application settings)
    • Usage: milesoft settings app get [flags]
  • set (Update application's configuration fields; only provided flags will be updated)
    • Usage: milesoft settings app set [flags]
    • Sub-flags:
      • --logo-url string: New logo image URL for the app.
      • --title string: New title for the app.
      • --url string: New URL for the app.
      • --version-major int: Major version number.
      • --version-minor int: Minor version number.
      • --version-patch int: Patch version number.
      • --welcome-admin string: Welcome message for admin users.
      • --welcome-user string: Welcome message for regular users.
Examples
Retrieve Current Application Settings (TTY Layout)
$ milesoft settings app get
=========================================================================
             Current App
=========================================================================
App ID:      app-xyz-prod
Name:        Main Developer Suite
URL:         https://admin.milesoft.io
Logo URL:    https://milesoft.io/logo.png
Type:        MultiTenant
Version:     1.2.3
Created:     2026-07-10T12:00:00Z
Updated:     2026-07-15T14:30:00Z
=========================================================================
Retrieve Current Application Settings as JSON
$ milesoft settings app get --json

JSON Schema Result:

{
  "id": "app-xyz-prod",
  "title": "Main Developer Suite",
  "url": "https://admin.milesoft.io",
  "logoUrl": "https://milesoft.io/logo.png",
  "type": "custom",
  "version": {
    "major": 1,
    "minor": 2,
    "patch": 3
  },
  "created": "2026-07-10T12:00:00Z",
  "updated": "2026-07-15T14:30:00Z"
}
Extract a Single Field Value (e.g. Title)
$ milesoft settings app get --field title
Main Developer Suite
Update Application Settings (TTY Layout)
$ milesoft settings app set --title "My Suite Portal" --version-major 2
=========================================================================
             Updated App
=========================================================================
App ID:      app-xyz-prod
Name:        My Suite Portal
URL:         https://admin.milesoft.io
Logo URL:    https://milesoft.io/logo.png
Type:        MultiTenant
Version:     2.2.3
Created:     2026-07-10T12:00:00Z
Updated:     2026-07-17T15:30:00Z
=========================================================================

milesoft settings contacts

Retrieve and update configuration settings associated with contacts graph ownership in the Contacts Graph.

  • get (Retrieve current contacts settings)
    • Usage: milesoft settings contacts get [flags]
  • set (Update contacts configuration fields; only provided flags will be updated)
    • Usage: milesoft settings contacts set [flags]
    • Sub-flags:
      • --graph-owned-by-user: Whether the contacts graph is owned by the user.
Examples
Retrieve Contacts Settings (TTY Layout)
$ milesoft settings contacts get
=========================================================================
             Contacts Settings
=========================================================================
Graph Owned By User: false
Created:             2026-07-10T12:00:00Z
Updated:             2026-07-15T14:30:00Z
=========================================================================
Retrieve Contacts Settings as JSON
$ milesoft settings contacts get --json

JSON Schema Result:

{
  "graphOwnedByUser": false,
  "created": "2026-07-10T12:00:00Z",
  "updated": "2026-07-15T14:30:00Z"
}
Toggle Contacts Graph Ownership (TTY Layout)
$ milesoft settings contacts set --graph-owned-by-user=true
=========================================================================
             Updated Contacts Settings
=========================================================================
Graph Owned By User: true
Created:             2026-07-10T12:00:00Z
Updated:             2026-07-17T15:30:00Z
=========================================================================

milesoft settings games

Retrieve and update configuration settings associated with the games module in the Games Engine.

  • get (Retrieve current games settings)
    • Usage: milesoft settings games get [flags]
  • set (Update games configuration fields; only provided flags will be updated)
    • Usage: milesoft settings games set [flags]
    • Sub-flags:
      • --base-url string: Base URL of the games module.
      • --best: Enable best tracking.
      • --campaign: Enable campaign mode.
      • --challenge-type string: Challenge game type.
      • --max-campaign-level int: Max campaign level.
      • --median: Enable median tracking.
      • --min-stars int: Min stars.
      • --num-tasks-allowed-per-day int: Number of tasks allowed per day.
      • --weekly-game-type string: Weekly game type.
Examples
Retrieve Games Settings (TTY Layout)
$ milesoft settings games get
=========================================================================
             Games Settings
=========================================================================
Base URL:                  https://sudoku.milesoft.io
Campaign:                  false
Best:                      false
Median:                    false
Num Tasks Allowed Per Day: 0
Max Campaign Level:        0
Min Stars:                 0
Weekly Game Type:          
Challenge Type:            
Created:                   2026-07-10T12:00:00Z
Updated:                   2026-07-15T14:30:00Z
=========================================================================
Retrieve Games Settings as JSON
$ milesoft settings games get --json

JSON Schema Result:

{
  "baseUrl": "https://sudoku.milesoft.io",
  "campaign": false,
  "best": false,
  "median": false,
  "numTasksAllowedPerDay": 0,
  "maxCampaignLevel": 0,
  "minStars": 0,
  "weeklyGameType": "",
  "challengeType": "",
  "created": "2026-07-10T12:00:00Z",
  "updated": "2026-07-15T14:30:00Z"
}
Update Games Settings (TTY Layout)
$ milesoft settings games set --campaign=true --max-campaign-level 50
=========================================================================
             Updated Games Settings
=========================================================================
Base URL:                  https://sudoku.milesoft.io
Campaign:                  true
Best:                      false
Median:                    false
Num Tasks Allowed Per Day: 0
Max Campaign Level:        50
Min Stars:                 0
Weekly Game Type:          
Challenge Type:            
Created:                   2026-07-10T12:00:00Z
Updated:                   2026-07-17T15:30:00Z
=========================================================================

milesoft settings notifications

Retrieve and update configuration settings associated with notification delivery in the Notification Engine.

  • get (Retrieve current notification delivery settings)
    • Usage: milesoft settings notifications get [flags]
  • set (Update notification configuration fields; only provided flags will be updated)
    • Usage: milesoft settings notifications set [flags]
    • Sub-flags:
      • --auth-json string: Service account service key JSON credentials.
      • --method string: Notification delivery method (None, Mobile, App, Email).
      • --project-id string: Google Cloud Project ID.
      • --sendgrid-from string: SendGrid sender email address.
      • --sendgrid-api-key string: SendGrid API key credential.
      • --twilio-from string: Twilio sender phone number.
      • --twilio-sid string: Twilio Account SID credential.
      • --twilio-token string: Twilio Auth Token credential.
Examples
Retrieve Notification Settings (TTY Layout)
$ milesoft settings notifications get
=========================================================================
             Notification Settings
=========================================================================
Method:            None
Project ID:        
Auth JSON:         
SendGrid From:     
SendGrid API Key:  
Twilio From:       
Twilio SID:        
Twilio Token:      
Created:           2026-07-10T12:00:00Z
Updated:           2026-07-15T14:30:00Z
=========================================================================
Retrieve Notification Settings as JSON
$ milesoft settings notifications get --json

JSON Schema Result:

{
  "method": "None",
  "projectId": "",
  "authJson": "",
  "sendGridFrom": "",
  "sendGridApiKey": "",
  "twilioFrom": "",
  "twilioSid": "",
  "twilioToken": "",
  "created": "2026-07-10T12:00:00Z",
  "updated": "2026-07-15T14:30:00Z"
}
Update Notification Settings (TTY Layout)
$ milesoft settings notifications set --method Email --project-id my-gcp-project --sendgrid-from info@milesoft.io --sendgrid-api-key sg_key_secret
=========================================================================
             Updated Notification Settings
=========================================================================
Method:            Email
Project ID:        my-gcp-project
Auth JSON:         
SendGrid From:     info@milesoft.io
SendGrid API Key:  sg_key_secret
Twilio From:       
Twilio SID:        
Twilio Token:      
Created:           2026-07-10T12:00:00Z
Updated:           2026-07-17T15:30:00Z
=========================================================================