milesoft sdk

Manage and inspect Milesoft SDK libraries and platform extensions directly from the terminal.

The command is fully dynamic: it pulls latest metadata from the local workspace files, but has a built-in remote fallback to retrieve metadata from the secure production website.

milesoft sdk list

Retrieve and display the collection of available SDK libraries, showing names, types, versions, and descriptions.

Operational Overview

• Dynamic Retrieval: Scans the active workspace directories for sdks-manifest.json.
• Remote Fallback: If not found locally, or if running outside a workspace, the command dynamically retrieves the live manifest (sdks-manifest.json) from the secure production website (https://milesoft.io/docs/sdks-manifest.json).
• Type Filtering: Supports filtering artifacts by type using the --type (or -t) flag. Available types are:
  • sdk: Core client libraries interfacing with backend microservices (e.g. accounts-sdk, liquid-sdk).
  • extension: Platform adapters for external third-party integrations (e.g. stripe-ext, twilio-ext).
  • library: Shared base utility, configuration, or structural frameworks (e.g. app-stack, primitives, commons).
• Output Mode Selection:
  • Terminal (TTY) Mode: Renders a clean tabular layout with distinct columns: ID, NAME, TYPE, VERSION, and DESCRIPTION.
  • Non-Interactive / JSON Mode: When standard output is redirected/piped, or when standard output is not a terminal, or when the global --json flag is provided, the command automatically falls back to printing the compact raw JSON representation of the manifest.

• Usage: milesoft sdk list [flags]

Examples

Terminal TTY Output (Default View)

$ milesoft sdk list
==================================================================================================================================================
ID                     NAME                       TYPE         VERSION      DESCRIPTION
==================================================================================================================================================
accounts-sdk           Accounts SDK               sdk          2.0.0        Accounts SDK library integration
app-stack              App Stack Framework        library      2.1.0        Full-stack application scaffolding and configuration...
stripe-ext             Stripe Extension           extension    2.0.0        Documentation for the stripe-ext SDK integration
==================================================================================================================================================

Filtering by Type (via --type or -t)

$ milesoft sdk list --type=extension

Automated JSON Output (via Pipe, Redirect, or --json)

$ milesoft sdk list --json

JSON Schema Result:

[
  {
    "id": "accounts-sdk",
    "name": "Accounts SDK",
    "latestVersion": "2.0.0",
    "docPath": "sdks/accounts-sdk.md",
    "type": "sdk",
    "description": "Accounts SDK library integration",
    "package": {
      "group": "io.milesoft",
      "artifact": "accounts-sdk",
      "snippet": "implementation "io.milesoft:accounts-sdk:2.1.0""
    }
  }
]

milesoft sdk get

Retrieve and display detailed metadata, type, versions, and packaging snippets for a specific SDK by its ID.

Operational Overview

• Target Selection: Looks up the SDK by its ID (case-insensitive).
• Surgical Field Extraction: Fully supports the persistent global --field flag (e.g. --field snippet), allowing you to extract just the raw dependency string, type, or latest version for automated workspace configuration or scripting.

• Usage: milesoft sdk get [sdk-id] [flags]

Examples

Terminal TTY Output (Default)

$ milesoft sdk get accounts-sdk
================================================================================
SDK DETAILS: Accounts SDK
================================================================================
ID:             accounts-sdk
Name:           Accounts SDK
Type:           sdk
Latest Version: 2.0.0
Doc Path:       sdks/accounts-sdk.md
Description:    Accounts SDK library integration
Group:          io.milesoft
Artifact:       accounts-sdk
Snippet:        implementation "io.milesoft:accounts-sdk:2.1.0"
================================================================================

Automated JSON Output (via Pipe, Redirect, or --json)

$ milesoft sdk get accounts-sdk --json

Surgical Field Extraction (via --field)

$ milesoft sdk get accounts-sdk --field snippet
implementation "io.milesoft:accounts-sdk:2.1.0"