Skip to main content

Getting started

By the end of this page you have a project on your machine, signed in to MachineMetrics, and an app rendering inside the local playground that stands in for a dashboard. Publishing comes after, on Publish your app.

With the Carbide plugin​

The fastest path uses Claude Code with the Carbide plugin. One command adds the MachineMetrics plugin marketplace, installs the plugin, and starts it:

claude "/plugin marketplace add machinemetrics/plugins && /plugin install carbide@machinemetrics && /carbide:start"

/carbide:start checks for Node 24 and npm, installs the mmdev command line tool if it is missing, signs you in with mmdev login, creates a development OAuth client for your project, and then walks through deciding what to build, scaffolding it from a template, building the interface with mm-react-components, and previewing it in the playground.

See Carbide plugin for what the plugin's skills do.

By hand​

Everything the plugin does, you can do yourself with mmdev.

  1. Install mmdev (macOS, Linux, or Windows via WSL):

    /bin/bash -c "$(curl -fsSL https://machinemetrics-public.s3.us-west-2.amazonaws.com/MMDevCli/install_cli.sh)" && exec $SHELL -l

  2. Sign in and create the development OAuth client for this environment. The client is what lets your app sign users in. There is one per environment, shared by every project on your machine, bound to http://development.machinemetrics.com on ports 3000 through 3010. It must exist before mmdev create.

    mmdev login
    mmdev oauth dev-init

  3. Create the project from the template that matches the app you want:

    AppTemplate
    Pagemmdev create my-app -t carbide-app
    Tabmmdev create my-app -t carbide-tab
    Widget, or not sure yetmmdev create my-app -t carbide

    mmdev create writes your development client id into app/public/default.json.

  4. Run it:

    cd my-app/app
    npm install
    npm start

    The app is served at http://development.machinemetrics.com:3000. Opening it directly asks you to sign in to MachineMetrics.

  5. In a second terminal, start the playground, which hosts your app the way a dashboard does:

    mmdev playground

    Open the URL it prints, press Cmd+K (Ctrl+K on Windows and Linux), enter http://development.machinemetrics.com:3000, and choose page, widget, or tab. The first launch asks you to authorize your development client once.

You now have an app running inside a MachineMetrics host. npm run verify in the app directory is the project's gate: lint, types, build, and tests.

Next​

Publish your app: deploy it over HTTPS and register it so your team can use it.