Skip to main content

Studio CLI for App Developers

The Studio CLI is a suite of developer and DevOps tools that becomes available when the framework-m-studio package is installed. It provides standardized workflows for building, securing, and releasing Framework M applications.

Overview​

While the core m CLI handles basic framework operations (migrations, console, info), the Studio CLI extensions focus on the application lifecycle. By using these tools, app developers inherit the same high standards for security and release management used by the framework itself.

DevOps & Release Management​

The m release command suite automates the complex process of versioning and releasing multi-package applications.

Planning a Release​

Use m release plan to see which components in your project need a version bump based on Conventional Commits.

m release plan --root ./my-app

Preparing the Release​

The prepare command handles the "heavy lifting" of a release:

  1. Version Bumping: Updates pyproject.toml or package.json.
  2. Changelog Generation: Automatically prepends new entries to CHANGELOG.md.
  3. Dependency Pinning: Updates workspace dependencies to ensure internal consistency.
  4. SBOM Generation: Generates a Software Bill of Materials via Syft.
m release prepare --branch release/v1.2.0

Finalizing the Release​

Once the release branch is ready and tested, use m release tag to create annotated git tags and (if configured) create a release on GitLab or GitHub.

Security Scanning​

Security shouldn't be an afterthought. The Studio CLI integrates Bandit directly via m security.

# Scan your application apps and libs for security vulnerabilities
m security

This command acts as a pass-through, allowing you to run security audits without manually configuring standalone security tools for every project.

Dependency Maintenance​

Keeping dependencies up to date is simplified with the m deps command. It supports both Python (uv) and JavaScript/TypeScript (pnpm) environments.

  • Check Updates: m deps check --manager uv
  • Automated Upgrades: m deps upgrade <package-name> (Can be configured to automatically create Merge Requests/Pull Requests).

Enterprise Documentation & Knowledge Management​

For large-scale application development, the Studio CLI provides "Enterprise-grade" documentation tools that were previously reserved for the framework core.

ADR & RFC Management​

Maintain a clear decision-making history using Architecture Decision Records (ADRs) and Request for Comments (RFCs) within your app repository.

  • Enforce Standards: Use m docs adr --verify and m docs rfc --verify to ensure all decision records follow a consistent format and numbering.
  • Traceability: Link technical decisions directly to your application code.

RAG & AI Knowledge Bases​

If your enterprise uses AI assistants or RAG systems, the Studio CLI can bridge the gap between your documentation and your LLMs.

  • JSONL Corpus Export: m docs export corpus generates a machine-readable JSONL file containing all your documentation, DocTypes, and features.
  • Optimized for Indexing: The export is structured specifically for easier ingestion by AI/RAG indexing pipelines.

Why use Studio CLI?​

Using the Studio CLI ensures that your application follows the Framework M standards:

  • Consistency: Your release process matches the framework's, making it easier for others to contribute.
  • Auditability: Automated SBOM and changelog generation provide a clear audit trail.
  • Portability: All commands work identically on your local machine and in CI pipelines.