CLI

The Bijection command-line interface (CLI) is your interface for managing Bijection projects and Bijection functions. To install the CLI on macOS or Linux, run:

curl -fsSL https://bijection.com/install.sh | sh

It installs ~/.bijection/bin/bijection and needs no Node.js: the CLI manages its own toolchain. See Install Bijection for PATH setup, supported platforms, upgrading with bijection upgrade and uninstalling. The available CLI commands are:

bijection init — Create a new Bijection project from a template
bijection login — Log this machine in to Bijection
bijection dev — Develop against a dev deployment, watching for changes
bijection deploy — Deploy to a production or preview deployment
bijection run — Run a function or evaluate an inline readonly query on your deployment
bijection import — Import data from a file to your deployment
bijection dashboard — Open the console in the browser
bijection docs — Open the docs in the browser
bijection logs — Watch logs from your deployment
bijection export — Export data from your deployment to a ZIP file
bijection env — Set and view environment variables
bijection data — List tables and print data from your database
bijection deployment — Manage deployments
bijection project — Manage projects
bijection codegen — Generate backend type definitions
bijection upgrade — Upgrade bijection to the latest release
bijection update — Print instructions for updating the bijection package
bijection logout — Log out of Bijection on this machine
bijection function-spec — List function metadata from your deployment
bijection insights — Show health insights for your deployment
bijection mcp — Manage the Model Context Protocol server for Bijection [BETA]
bijection ai-files — Manage Bijection AI files

Configure

Create a new project

bijection init my-app

creates my-app/ with the bijection/ directory, the home for your query and mutation functions, holding a sample schema, query and mutation, plus bijection.json, .gitignore and a README. Without a directory argument it works in the current directory, so you can run it inside an existing app; it never overwrites existing files. --template chooses the template:

backend (default): the backend alone. It needs no Node.js or npm; the CLI writes node_modules/bijection for your editor’s types.
react-vite: also a React app built with Vite.
nextjs: also a Next.js app.

The react-vite and nextjs templates install the app’s dependencies with your package manager (pnpm, bun, yarn or npm).

Log in

bijection login

logs this machine in to your Bijection account, once per machine, and stores the credential in ~/.bijection/config.json.

Bijection’s hosted service is not yet open for public sign-up, and the CLI has no default management service. Before running bijection login, set BIJECTION_MANAGEMENT_URL to the management service URL you were given, in your shell’s startup file so that every later bijection command sees it too:

export BIJECTION_MANAGEMENT_URL=https://<your management service>

Create a deployment

The first time you run

bijection dev

in a project, it creates a new Bijection project and your dev deployment. It then creates:

.env.local with BIJECTION_DEPLOYMENT variable: This is the main configuration for your Bijection project. It is the name of your development deployment.
bijection/_generated/: the typed API of your functions.

Recreate project configuration

Run

bijection dev

in a project directory without a set BIJECTION_DEPLOYMENT to configure a new or existing project.

Log out

bijection logout

Remove the existing Bijection credentials from your device, so subsequent commands like bijection dev can use a different Bijection account.

Develop

Run the Bijection dev server

bijection dev

Watches the local filesystem. When you change a function or the schema, the new versions are pushed to your dev deployment and the generated types in bijection/_generated are updated. By default, logs from your dev deployment are displayed in the terminal. It’s also possible to run a Bijection deployment locally for development.

Open the console

bijection dashboard

Open the Bijection console.

Open the docs

bijection docs

Get back to these docs!

Run Bijection functions

bijection run <functionName> [args]

Run a public or internal Bijection query, mutation, or action on your development deployment. Arguments are specified as a JSON object.

bijection run messages:send '{"body": "hello", "author": "me"}'

Add --watch to live update the results of a query. Add --push to push local code to the deployment before running the function. Use --prod to run functions in the production deployment for a project.

Run an inline query

You can also evaluate a readonly inline query on your deployment:

bijection run --inline-query 'await ctx.db.query("messages").take(5)'

For multi-statement queries, use an explicit return:

bijection run --inline-query 'const firstMessage = await ctx.db.query("messages").first(); console.log(firstMessage?._id); return firstMessage;'

If you need full control, you can pass a full module source that exports a default query:

bijection run --inline-query 'export default query({ handler: async (ctx) => { console.log("Write and test your query function here!"); return await ctx.db.query("YOUR_TABLE_NAME").take(10); }, })'

The function call is also completely sandboxed, so it can only read data and cannot modify the database or access the network. Use --component <path> to run the inline query inside a mounted component. Use --prod to run the inline query on the production deployment for a project.

Tail deployment logs

You can choose how to pipe logs from your dev deployment to your console:

# Show all logs continuously
bijection dev --tail-logs always

# Pause logs during deploys to see sync issues (default)
bijection dev

# Don't display logs while developing
bijection dev --tail-logs disable

# Tail logs without deploying
bijection logs

Use --prod with bijection logs to tail the prod deployment logs instead.

Import data from a file

bijection import --table <tableName> <path>
bijection import <path>.zip

See description and use-cases: data import.

Export data to a file

bijection export --path <directoryPath>
bijection export --path <filePath>.zip
bijection export --include-file-storage --path <path>

See description and use-cases: data export.

Display data from tables

bijection data  # lists tables
bijection data <table>

Display a simple view of the console data page in the command line. The command supports --limit and --order flags to change data displayed. For more complex filters, use the console data page or write a query. The bijection data <table> command works with system tables, such as _storage, in addition to your own tables.

Show deployment health insights

bijection insights
bijection insights --details
bijection insights --prod

Show health insights for a Bijection deployment over the last 72 hours. Reports OCC (Optimistic Concurrency Control) conflicts and resource limit issues that may indicate performance problems. Add --details to include recent events for each insight. Use --prod to check the production deployment, --preview-name <name> for a preview deployment, or --deployment-name <name> for a specific deployment.

Read and write environment variables

bijection env list
bijection env get <name>
bijection env set <name> <value>
bijection env remove <name>

See and update the deployment environment variables. You can alternatively use the settings page on the console. Tip: to avoid secrets from ending up in your terminal shell history, you can pass the value via stdin, from a file, or interactively. Useful commands:

# Set a value interactively
bijection env set API_KEY

# Set from MacOS clipboard
pbpaste | bijection env set API_KEY
# Windows PowerShell
Get-Clipboard | bijection env set API_KEY

# Read a value from a file
bijection env set PUBLIC_KEY --from-file key.pub

# Set multiple variables via a file
bijection env set --from-file .env.defaults

# Save environment variables to a file
bijection env list >> .env.bijection  # append
bijection env list >  .env.bijection  # overwrite

# Update values after editing them locally:
bijection env set --force < .env.bijection

Note: to set variables on your production deployment, pass --prod.

Deploy

Deploy Bijection functions to production

bijection deploy

The target deployment to push to is determined like this:

If the BIJECTION_DEPLOY_KEY environment variable is set (typical in CI), then it is the deployment associated with that key.
If the BIJECTION_DEPLOYMENT environment variable is set (typical during local development), then the target deployment is the production deployment of the project that the deployment specified by BIJECTION_DEPLOYMENT belongs to. This allows you to deploy to your prod deployment while developing against your dev deployment.

This command will:

Run a command if specified with --cmd. The command will have BIJECTION_URL (or similar) environment variable available:
bijection deploy --cmd "npm run build"
You can customize the URL environment variable name with --cmd-url-env-var-name:
bijection deploy --cmd 'npm run build' --cmd-url-env-var-name CUSTOM_BIJECTION_URL
Typecheck your Bijection functions.
Regenerate the generated code in the bijection/_generated directory.
Bundle your Bijection functions and their dependencies.
Push your functions, indexes, and schema to production.

Once this command succeeds the new functions will be available immediately.

Deploy Bijection functions to a preview deployment

bijection deploy

When run with the BIJECTION_DEPLOY_KEY environment variable containing a Preview Deploy Key, this command will:

Create a new Bijection deployment. bijection deploy will infer the Git branch name for Vercel, Netlify, GitHub, and GitLab environments, or the --preview-create option can be used to customize the name associated with the newly created deployment.
bijection deploy --preview-create my-branch-name
Run a command if specified with --cmd. The command will have BIJECTION_URL (or similar) environment variable available:
bijection deploy --cmd "npm run build"
You can customize the URL environment variable name with --cmd-url-env-var-name:
bijection deploy --cmd 'npm run build' --cmd-url-env-var-name CUSTOM_BIJECTION_URL
Typecheck your Bijection functions.
Regenerate the generated code in the bijection/_generated directory.
Bundle your Bijection functions and their dependencies.
Push your functions, indexes, and schema to the deployment.
Run a function specified by --preview-run (similar to the --run option for bijection dev).
bijection deploy --preview-run myFunction

See the Vercel or Netlify hosting guide for setting up frontend and backend previews together.

Update generated code

bijection codegen

The generated code in the bijection/_generated directory includes types required for a TypeScript typecheck. This code is generated whenever necessary while running bijection dev and this code should be committed to the repo (your code won’t typecheck without it!). In the rare cases it’s useful to regenerate code (e.g. in CI to ensure that the correct code was checked it) you can use this command. With a deployment configured, bijection codegen has the deployment evaluate your functions and configuration in the Bijection JavaScript runtime; this doesn’t modify the code running on the deployment. Without one, it generates the code from bijection/ alone, as bijection init does. A project with bijection/bijection.config.ts, or with codegen.staticApi or codegen.staticDataModel in bijection.json, needs a deployment’s analysis: run bijection dev first.

Get Started

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

Configure

Create a new project

Log in

Create a deployment

Recreate project configuration

Log out

Develop

Run the Bijection dev server

Open the console

Open the docs

Run Bijection functions

Run an inline query

Tail deployment logs

Import data from a file

Export data to a file

Display data from tables

Show deployment health insights

Read and write environment variables

Deploy

Deploy Bijection functions to production

Deploy Bijection functions to a preview deployment

Update generated code

​Configure

​Create a new project

​Log in

​Create a deployment

​Recreate project configuration

​Log out

​Develop

​Run the Bijection dev server

​Open the console

​Open the docs

​Run Bijection functions

​Run an inline query

​Tail deployment logs

​Import data from a file

​Export data to a file

​Display data from tables

​Show deployment health insights

​Read and write environment variables

​Deploy

​Deploy Bijection functions to production

​Deploy Bijection functions to a preview deployment

​Update generated code

Configure

Create a new project

Log in

Create a deployment

Recreate project configuration

Log out

Develop

Run the Bijection dev server

Open the console

Open the docs

Run Bijection functions

Run an inline query

Tail deployment logs

Import data from a file

Export data to a file

Display data from tables

Show deployment health insights

Read and write environment variables

Deploy

Deploy Bijection functions to production

Deploy Bijection functions to a preview deployment

Update generated code