Skip to main content

IDP CLI Reference

The idp CLI is the primary interface for the Muslito Internal Developer Platform. Use it to generate service scaffolds, deploy infrastructure blueprints, and check for updates.

Installation

npm install -g @muslito/idp-cli

Global flags

FlagDescription
--help, -hShow help for any command
--version, -vPrint CLI version

Scaffold commands

idp scaffold list

List all available scaffold types.

idp scaffold list

Output:

Available scaffolds:
nodejs Node.js / Fastify service (TypeScript)
fastapi Python / FastAPI service

idp scaffold new

Generate a new service from a scaffold template.

idp scaffold new --type <type> --name <name> [options]

Required flags:

FlagDescription
--typeScaffold type: nodejs or fastapi
--nameService name (used for folder name, package name, etc.)

Optional flags:

FlagDefaultDescription
--output./Directory where the service folder is created
--description""Short description written into package.json / pyproject.toml

Examples:

# Generate a Node.js service in the current directory
idp scaffold new --type nodejs --name user-service

# Generate a FastAPI service in a custom output folder with description
idp scaffold new \
--type fastapi \
--name payment-service \
--output ./services \
--description "Handles payment processing"

idp scaffold check

Check whether a generated service is on the latest scaffold version.

idp scaffold check [--path <path>]

Optional flags:

FlagDefaultDescription
--path./Path to the service directory

Example:

idp scaffold check --path ./services/my-service

Blueprint commands

idp blueprint list

List all available infrastructure blueprints.

idp blueprint list

Output:

Available blueprints:
apigw-lambda-dynamodb Serverless REST API + DynamoDB
ecs-fargate-rds Containerised service + PostgreSQL
cache-layer ElastiCache Redis add-on
event-driven EventBridge + SQS + Lambda consumer
secrets-and-config Secrets Manager + SSM Parameter Store

idp blueprint info

Show details, parameters, and resource list for a specific blueprint.

idp blueprint info <blueprint-id>

Example:

idp blueprint info apigw-lambda-dynamodb

idp blueprint deploy

Deploy an infrastructure blueprint to AWS.

idp blueprint deploy <blueprint-id> --name <name> --env <env> --region <region> [options]

Required flags:

FlagDescription
--nameService / resource name prefix
--envTarget environment (dev, staging, production)
--regionAWS region (e.g. us-east-1)

Optional flags (blueprint-specific):

Refer to each blueprint's documentation page for its full list of configurable parameters passed via --context flags.

Example:

idp blueprint deploy apigw-lambda-dynamodb \
--name my-api \
--env dev \
--region us-east-1

Available scaffolds

TypeFrameworkLanguage
nodejsFastify 4TypeScript
fastapiFastAPIPython 3.12

Available blueprints

IDDescription
apigw-lambda-dynamodbServerless REST API + DynamoDB
ecs-fargate-rdsContainerised service + PostgreSQL
cache-layerElastiCache Redis add-on
event-drivenEventBridge + SQS + Lambda
secrets-and-configSecrets Manager + SSM