The CLI + SDK for building Cast modules — typed manifests of Objects, Fields, Roles, Workflows, Views, and LogicFunctions that install into a Lattice workspace. One of the eight Visca products. Built on the open Lattice Runtime foundation.

Quick start

The recommended way to start is with create-cast-module:

npx create-cast-module@latest my-module
cd my-module
yarn cast dev

Documentation

Full documentation is available at docs.latticeruntime.com/developers/extend/modules:

• Getting Started — scaffolding, local server, authentication, dev mode
• Building Apps — entity definitions, API clients, testing, CLI reference
• Publishing — deploy, npm publish, marketplace

Manual installation

If you are adding @autonomy-cloud/cast-sdk to an existing project instead of using create-cast-module:

yarn add @autonomy-cloud/cast-sdk @autonomy-cloud/cast-client-sdk

Then add a lattice script to your package.json:

{
  "scripts": {
    "lattice": "lattice"
  }
}

Run yarn cast help to see all available commands.

Configuration

The CLI stores credentials per remote in ~/.lattice/config.json. Run yarn cast remote add to configure a remote, or yarn cast remote list to see existing ones.

Troubleshooting

• Auth errors: run yarn cast remote add to re-authenticate.
• Typings out of date: restart yarn cast dev to refresh the client and types.
• Not seeing changes in dev: make sure dev mode is running (yarn cast dev).

Contributing

Development setup

git clone https://github.com/latticehq/lattice.git
cd lattice
yarn install

Development mode

npx nx run cast-sdk:dev

Production build

npx nx run cast-sdk:build

Running the CLI locally

npx nx run cast-sdk:start -- <command>

Resources

• See our GitHub
• Join our Discord