@interface-db/cli

InterfaceDB's CLI.

Documentation · Source

Maintained by InterfaceDB, based on the Instant source. See LICENSE.md and NOTICE for attribution.

Welcome to InterfaceDB’s command line tool. You can create apps, write schema, and push permissions.

npx @interface-db/cli init

Get Started

Start by peeking at the interfacedb docs.

Contributing

Here's how to set up a local development environment for interfacedb.

Quick Start

Clone this repo
git clone ..

# If you made any backend changes, run the server locally in a separate terminal
cd server
make dev

# Add --filter @interface-db/cli to the 'dev' script in client/package.json to include
# interfacedb in the dev process
"dev": "turbo run dev ... --filter @interface-db/cli"

# Now run the client to listen to cli changes
cd client
make dev

# Now go into a place where you can test out the CLI in your terminal
cd client/sandbox/cli-nodejs
INSTANT_CLI_DEV=1 npx @interface-db/cli ...

Testing local builds

You can link a local build of interfacedb globally so it's available as a regular command:

cd client/packages/cli
pnpm build
pnpm link --global
which interfacedb # should point to your pnpm global bin dir

Now you can run interfacedb anywhere and it will use your local build.

To unlink:

pnpm unlink --global @interface-db/cli

Questions?

If you have any questions, feel free to drop us a line on our issue tracker