milesoft docs
Search, view, and list the Milesoft platform's developer guides and high-density knowledge base (llms.txt) directly from the terminal.
The command is fully dynamic: it pulls latest content from the production website, but has built-in offline/local fallbacks to ensure robust, zero-latency execution.
milesoft docs list
Retrieve and display available documentation guides in the public/docs/ hierarchy.
Operational Overview
- Dynamic Retrieval: Scans the active documentation tree by downloading a live sitemap manifest (
docs-manifest.json) from the production website. - Offline Fallback: If offline, or if the network request exceeds 2 seconds, the command seamlessly falls back to using the compiled-in guide listings.
- Output Mode Selection:
- Terminal (TTY) Mode: Renders an elegant 114-character ASCII table displaying path and description columns.
- Non-Interactive / JSON Mode: When standard output is piped/redirected, or when the global
--jsonflag is provided, the command automatically falls back to printing a structured JSON representation of the manifest.
- Usage:
milesoft docs list [flags]
Examples
Terminal TTY Tabular Output (Default)
$ milesoft docs list
==================================================================================================================================
PATH DESCRIPTION
==================================================================================================================================
cli/cli-overview.md Comprehensive CLI usage instructions and command reference guide
cli/account.md Detailed guide for account management
cli/app.md Detailed guide for managing applications
cli/docs.md Detailed guide for search, view, and list operations of CLI platform documentation
cli/integration.md Detailed guide for integration configuration
cli/mcp.md Comprehensive integration guide for Model Context Protocol (MCP) server mode
cli/sdks.md Detailed guide for listing and inspecting platform SDK libraries
cli/settings.md Detailed guide for CLI local settings
cli/template.md Detailed guide for Shopify Liquid template compiling
cli/type.md Detailed guide for managing custom user roles and permissions
cli/user.md Detailed guide for managing tenant users and profiles
extensions/cloudinary-ext.md Documentation for the cloudinary-ext SDK integration
extensions/firestore-ext.md Documentation for the firestore-ext SDK integration
extensions/linkedin-ext.md Documentation for the linkedin-ext SDK integration
extensions/openai-ext.md Documentation for the openai-ext SDK integration
extensions/openpojo-ext.md Documentation for the openpojo-ext SDK integration
extensions/pubsub-ext.md Documentation for the pubsub-ext SDK integration
extensions/quickbooks-ext.md Documentation for the quickbooks-ext SDK integration
extensions/secrets-ext.md Documentation for the secrets-ext SDK integration
extensions/square-ext.md Documentation for the square-ext SDK integration
extensions/storage-ext.md Documentation for the storage-ext SDK integration
extensions/stripe-ext.md Documentation for the stripe-ext SDK integration
extensions/task-queue-ext.md Documentation for the task-queue-ext SDK integration
extensions/twilio-ext.md Documentation for the twilio-ext SDK integration
extensions/vertex-ext.md Documentation for the vertex-ext SDK integration
libraries/app-stack.md Full-stack application scaffolding and configuration for Milesoft projects
libraries/clients.md SDK client libraries for interacting with Milesoft platform services
libraries/commons.md Shared utilities and common functionality for the Milesoft platform
libraries/primitives.md Core primitive types and utilities for the Milesoft platform
onboarding/artifact-registry.md Detailed guide for Artifact Registry setup, Maven/Gradle repositories, and dependency ...
onboarding/getting-started.md Zero-to-one guide to bootstrap a Spring Boot application using Milesoft SDK clients
onboarding/platform.md Comprehensive overview of the platform architecture, service topology, and context pro...
onboarding/prerequisites.md Overview of required CLI tools and typical platform integration workflow
sdks/accounts-sdk.md Strongly-typed programmatic interface to identity, tenant management, and authenticati...
sdks/contacts-sdk.md Strongly-typed programmatic client for managing contact entities, relationship links, ...
sdks/games-sdk.md Strongly-typed SDK clients and callback contracts to manage progression, leaderboards,...
sdks/liquid-sdk.md Strongly-typed programmatic interface for Shopify Liquid template compilation, executi...
sdks/notifications-sdk.md Strongly-typed programmatic client for orchestrating cross-channel messaging and tenan...
==================================================================================================================================
Automated JSON Output (via Pipe, Redirect, or --json)
$ milesoft docs list --json
JSON Schema Result:
[
{
"path": "cli/cli-overview.md",
"description": "Comprehensive CLI usage instructions and command reference guide"
},
{
"path": "cli/account.md",
"description": "Detailed guide for account management"
}
]
milesoft docs view
Retrieve and render the complete high-density llms.txt knowledge base or a specific nested guide.
Operational Overview
- Path Resolution: Supports viewing files by their relative path under the public hierarchy (e.g.
cli/account.md,sdks/accounts-sdk.md). - Dynamic Content: Fetches raw markdown files dynamically from the live site on demand, falling back to local relative workspaces if running in development mode.
- Usage:
milesoft docs view [file/topic] [flags]
Examples
Terminal TTY Output (Default - llms.txt)
$ milesoft docs view
Terminal TTY Output (with --full - llms-full.txt)
$ milesoft docs view --full
Terminal TTY Output (Specific Guide)
$ milesoft docs view cli/account.md
milesoft docs search
Perform a case-insensitive query across the llms-full.txt index (falls back to llms.txt).
Operational Overview
- Highlighted Results: Performs a semantic search across the documentation lines, presenting matched terms with context line buffers and highlighting search matches directly in yellow in active terminals.
- Usage:
milesoft docs search [query]
Examples
Terminal TTY Search Output
$ milesoft docs search "authentication"
Searching for 'authentication' in Milesoft Developer Docs...
=========================================================================
[Line 42] (Context):
## Authentication & Security
...
>>> ### OAuth with PKCE Flow
The CLI uses proof key exchange for secure browser-based authentication.
-------------------------------------------------------------------------
Search complete. Found 15 matches.