Skip to content

guides

Intended Documentation

OpenShell Starter Kit

Use the Intended starter kit pattern to get MIR, the CLI, and the OpenShell adapter into a repo fast.

beginner2 min readimplemented

OpenShell Starter Kit#

This guide shows the recommended starter structure for getting Intended into a repo quickly when you are piloting OpenClaw, OpenShell, or NemoClaw-style runtime workflows.

What the starter kit is for#

Use the starter kit when you want to:

  • put MIR into a real repository
  • generate OpenShell policy artifacts locally
  • keep the first rollout lightweight
  • prove value before moving into shared hosted operations

Starter structure#

The in-repo starter layout is:

text
open-source/
  meritt-openshell-starter/
    README.md
    package.json
    meritt-openshell.json

The pattern is intentionally small. The goal is to make the first governed runtime pilot easy to copy into a real repo.

Install the open packages:

bash
pnpm add @intended/open-intent-layer @intended/openshell-adapter
pnpm add -g @intended/cli

Generate a policy artifact:

bash
meritt openshell-compile \
  --input meritt-openshell.json \
  --output meritt-openshell.yaml \
  --runtime openclaw \
  --provider nvidia

Apply it using the documented upstream interface:

bash
openshell policy set meritt-openshell.yaml

What stays local at first#

The starter kit is meant for repo-level and developer-level adoption. In the first pass, keep these steps local:

  • policy artifact generation
  • runtime configuration review
  • review-mode rollout
  • quick iteration on presets and allowed endpoints

When to move into hosted Intended#

Upgrade from the starter pattern to hosted Intended when you need:

  • maintained LIM intelligence
  • shared policy operations
  • multi-user approvals
  • runtime inventory
  • audit workflows and reporting
  • environment-aware rollout control

Suggested pilot flow#

  1. Start with one runtime path and one repo.
  2. Generate policy from MIR and the relevant LIM context.
  3. Roll out in staging first.
  4. Keep high-risk paths in review mode.
  5. Move to hosted Intended when more than one user or environment needs to govern the same runtime flow.

Next docs#