A CLI and SDK to develop, build, and publish applications that extend Chass.

Quick start

The recommended way to start is with create-chass-app:

npx create-chass-app@latest my-chass-app
cd my-chass-app
yarn chass dev

Documentation

Full documentation is available at docs.chass.app/developers/extend/apps:

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

Guides in this repository:

• Programmatic application builds, local builds and typechecking for scripts and integrations
• Logic function inputs — input schema inference, record-typed inputs, and the id contract

Manual installation

If you are adding the SDK to an existing project instead of using create-chass-app, install it under the twenty-sdk and twenty-client-sdk names that application code imports:

yarn add -D twenty-sdk@npm:@chassdev/sdk twenty-client-sdk@npm:@chassdev/client-sdk

Then add a chass script to your package.json:

{
  "scripts": {
    "chass": "chass"
  }
}

Run yarn chass help to see all available commands. The binary is also installed as twenty for existing scripts.

Configuration

The CLI stores credentials per remote in ~/.chass/config.json. Credentials from an existing ~/.twenty/config.json are copied there the first time the CLI needs them. Run yarn chass remote:add to configure a remote, or yarn chass remote:list to see existing ones.

Troubleshooting

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

Contributing

Development setup

From the monorepo root:

yarn install

Development mode

npx nx run twenty-sdk:dev

Production build

npx nx run twenty-sdk:build

Running the CLI locally

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