base44-cli

Base44 CLI

Create and manage Base44 apps (projects) using the Base44 CLI tool.

⚡ IMMEDIATE ACTION REQUIRED - Read This First

This skill activates on ANY mention of "base44" or when a base44/ folder exists. DO NOT read documentation files or search the web before acting.

Your first action MUST be:

1. Check if base44/config.jsonc exists in the current directory
2. If YES (existing project scenario):

• Transfer to base44-sdk skill for implementation
• This skill only handles CLI commands (login, deploy, entities push)
• Except running the app locally — stays here. Read Running Local Development

before starting a dev server: one way of running hits production data.

1. If NO, decide between two initialization paths:

• Provisioned app — the Base44 app already exists because it was just provisioned through a Stripe Projects / projects.dev flow, OR BASE44_APP_ID (or BASE44_PROJECTS_BASE44_APP_ID) is present in the environment or a .env/.env.local file:
• Run npx base44 scaffold to set up local files for that existing app
• DO NOT run `npx base44 create` — that creates a second, duplicate app. See scaffold.md.
• New project — no app exists yet and none was provisioned:
• This skill (base44-cli) handles the request; guide the user through npx base44 create
• Do NOT activate base44-sdk yet

Critical: Local Installation Only

NEVER call base44 directly. The CLI is installed locally as a dev dependency and must be accessed via a package manager:

• npx base44 <command> (npm - recommended)
• yarn base44 <command> (yarn)
• pnpm base44 <command> (pnpm)

WRONG: base44 login RIGHT: npx base44 login

MANDATORY: Authentication Check at Session Start

CRITICAL: At the very start of every AI session when this skill is activated, you MUST:

1. Check authentication status by running:

   npx base44 whoami

1. If the user is logged in (command succeeds and shows an email):

• Continue with the requested task

1. If the user is NOT logged in (command fails or shows an error):

• STOP immediately
• DO NOT proceed with any CLI operations
• Ask the user to login manually by running:

     npx base44 login

• Wait for the user to confirm they have logged in before continuing

This check is mandatory and must happen before executing any other Base44 CLI commands.

Provisioned via Stripe Projects / projects.dev? When the app was provisioned through that flow, the CLI seeds authentication from the BASE44_ACCESS_TOKEN / BASE44_REFRESH_TOKEN environment variables it injects (the BASE44_PROJECTS_*-prefixed names are normalized automatically). In that case npx base44 whoami already succeeds and you do not need an interactive npx base44 login.

Workspace API key set? If the BASE44_API_KEY environment variable is set to a workspace API key (prefixed b44k_), the CLI authenticates with it directly — npx base44 whoami and other commands succeed without an interactive login.

Overview

The Base44 CLI provides command-line tools for authentication, creating projects, managing entities, and deploying Base44 applications. It is framework-agnostic and works with popular frontend frameworks like Vite, Next.js, and Create React App, Svelte, Vue, and more.

When to Use This Skill vs base44-sdk

Use base44-cli when:

• Creating a NEW Base44 project from scratch
• Initializing a project in an empty directory
• Setting up local files for an existing app that was provisioned externally (e.g., through a Stripe Projects / projects.dev flow) → use scaffold
• Directory is missing base44/config.jsonc
• User mentions: "create a new project", "initialize project", "setup a project", "start a new Base44 app"
• Deploying, pushing entities, or authenticating via CLI
• Working with CLI commands (npx base44 ...)

Use base44-sdk when:

• Building features in an EXISTING Base44 project
• base44/config.jsonc already exists
• Writing JavaScript/TypeScript code using Base44 SDK
• Implementing functionality, components, or features
• User mentions: "implement", "build a feature", "add functionality", "write code"

Skill Dependencies:

• base44-cli is a prerequisite for base44-sdk in new projects
• If user wants to "create an app" and no Base44 project exists, use base44-cli first
• base44-sdk assumes a Base44 project is already initialized

State Check Logic: Before selecting a skill, check:

• IF (user mentions "create/build app" OR "make a project"):
• IF (base44/config.jsonc exists):

→ Use base44-sdk (project exists, build features)

• ELSE IF (app was provisioned externally — BASE44_APP_ID/BASE44_PROJECTS_BASE44_APP_ID set, or a Stripe Projects / projects.dev flow just ran):

→ Use base44-cli → npx base44 scaffold (set up local files for the existing app; do NOT create)

• ELSE:

→ Use base44-cli → npx base44 create (new project initialization needed)

Project Structure

A Base44 project combines a standard frontend project with a base44/ configuration folder:

my-app/
├── base44/                      # Base44 configuration (created by CLI)
│   ├── config.jsonc             # Project settings, site config
│   ├── .types/                  # Auto-generated TypeScript types (created by `types generate`)
│   │   └── types.d.ts           # Module augmentation for @base44/sdk
│   ├── entities/                # Entity schema definitions
│   │   ├── task.jsonc
│   │   └── board.jsonc
│   ├── functions/               # Backend functions (optional)
│   │   └── my-function/
│   │       └── entry.ts
│   ├── agents/                  # Agent configurations (optional)
│   │   └── support_agent.jsonc
│   ├── agent-skills/            # Agent skill instructions (optional)
│   │   └── pdf-export.md
│   └── connectors/              # OAuth connector configurations (optional)
│       └── googlecalendar.jsonc
├── src/                         # Frontend source code
│   ├── api/
│   │   └── base44Client.js      # Base44 SDK client
│   ├── pages/
│   ├── components/
│   └── main.jsx
├── index.html                   # SPA entry point
├── package.json
└── vite.config.js               # Or your framework's config

Key files:

• base44/config.jsonc - Project name, description, site build settings
• base44/entities/*.jsonc - Data model schemas (see Entity Schema section)
• base44/functions/*/entry.ts - Backend function entry point
• base44/agents/*.jsonc - Agent configurations (optional)
• base44/agent-skills/*.md - Agent skill instructions (optional)
• base44/.types/types.d.ts - Auto-generated TypeScript types for entities, functions, and agents (created by npx base44 types generate)
• base44/connectors/*.jsonc - OAuth connector configurations (optional)
• src/api/base44Client.js - Pre-configured SDK client for frontend use

config.jsonc example:

{
  "name": "My App",                    // Required: project name
  "description": "App description",    // Optional: project description
  "visibility": "public",              // Optional: "public" | "private" | "workspace"
  "entitiesDir": "./entities",         // Optional: default "entities"
  "functionsDir": "./functions",       // Optional: default "functions"
  "agentsDir": "./agents",             // Optional: default "agents"
  "agentSkillsDir": "./agent-skills",  // Optional: default "agent-skills"
  "connectorsDir": "./connectors",     // Optional: default "connectors"
  "site": {                            // Optional: site deployment config
    "installCommand": "npm install",   // Optional: install dependencies
    "buildCommand": "npm run build",   // Optional: build command
    "serveCommand": "npm run dev",     // Optional: local dev server
    "outputDirectory": "./dist"        // Optional: build output directory
  }
}

Config properties:

Installation

Install the Base44 CLI as a dev dependency in your project:

npm install --save-dev base44

Important: Never assume or hardcode the base44 package version. Always install without a version specifier to get the latest version.

Then run commands using npx:

npx base44 <command>

Note: All commands in this documentation use npx base44. You can also use yarn base44, or pnpm base44 if preferred.

Global --app-id Option

The CLI has a global --app-id <id> option for commands that only need an app context, not local project files.

Resolution order: --app-id flag → BASE44_APP_ID environment variable → local base44/.app.jsonc

This is useful when you want to inspect or operate on an app without switching into a linked project directory. Common examples:

# Run a one-off script against a specific app
cat ./script.ts | npx base44 exec --app-id app_123

# Fetch logs for a deployed app without a local checkout
npx base44 logs --app-id app_123 --level error

Use --app-id for app-scoped commands like exec and logs.

Do not use --app-id for commands that need local project files:

• base44 create creates a new app, so it rejects --app-id
• base44 dev runs from a linked local project, so it rejects --app-id
• base44 deploy still requires a local project directory because it reads local resources

Global --json Option

The CLI has a global --json option that makes commands emit a machine-readable JSON document on stdout instead of human-oriented output. It also forces non-interactive mode (spinners/status messages/logs move to stderr), so stdout stays pure JSON — safe to pipe into jq or another program.

npx base44 connectors list-available --json
npx base44 logs --app-id app_123 --json

Available Commands

Authentication

Project Management

Workspace Management

Workspaces (a.k.a. organizations) group apps under shared membership. By default base44 create/base44 link --create use your personal workspace; pass -w, --workspace <id> to target another one.

Development

Deployment

Entity Management

Entity Schema (Quick Reference)

ALWAYS follow this exact structure when creating entity files:

File naming: base44/entities/{kebab-case-name}.jsonc (e.g., team-member.jsonc for TeamMember)

Schema template:

{
  "name": "EntityName",
  "type": "object",
  "properties": {
    "field_name": {
      "type": "string",
      "description": "Field description"
    }
  },
  "required": ["field_name"]
}

Field types: string, number, integer, boolean, array, object, binary String formats: date, date-time, time, email, uri, hostname, ipv4, ipv6, uuid, file, regex, richtext For enums: Add "enum": ["value1", "value2"] and optionally "default": "value1" Entity names: Must be alphanumeric only (pattern: /^[a-zA-Z0-9]+$/)

For complete documentation, see entities-create.md.

Function Management

Workflow Runs

Workflows are the automation system (cron schedules, entity triggers, connector events, in-app agent actions). These commands are read-only: they answer "what workflows exist" and "did my scheduled work fail, and why".

Agent Management

Agents are conversational AI assistants that can interact with users, access your app's entities, and call backend functions. Use these commands to manage agent configurations.

Note: Agent commands perform full synchronization - pushing replaces all remote agents with local ones, and pulling replaces all local agents with remote ones.

Agent Schema (Quick Reference)

File naming: base44/agents/{agent_name}.jsonc (e.g., support_agent.jsonc)

Schema template:

{
  "name": "agent_name",
  "description": "Brief description of what this agent does",
  "instructions": "Detailed instructions for the agent's behavior",
  "tool_configs": [
    // Entity tool - gives agent access to entity operations
    { "entity_name": "tasks", "allowed_operations": ["read", "create", "update", "delete"] },
    // Backend function tool - gives agent access to a function
    { "function_name": "send_email", "description": "Send an email notification" }
  ],
  "memory_config": {                 // Optional: lets the agent remember facts across conversations
    "enabled": true,
    "scope": "both",                 // "global" | "user" | "both"
    "include_other_conversation_context": false,
    "instructions": null
  },
  "whatsapp_greeting": "Hello! How can I help you today?"
}

Naming rules:

• Agent names must match pattern: /^[a-z0-9_]+$/ (lowercase alphanumeric with underscores, 1-100 chars)
• Valid: support_agent, order_bot
• Invalid: Support-Agent, OrderBot

Required fields: name, description, instructions Optional fields: tool_configs (defaults to []), memory_config, whatsapp_greeting

Tool config types:

• Entity tools: entity_name + allowed_operations (array of: read, create, update, delete)
• Backend function tools: function_name + description

Memory config fields (all optional, see agents-push.md for details): enabled (bool, default true), scope (global\|user\|both, default both), include_other_conversation_context (bool, default false), instructions (string\|null, default null)

Agent Skills Management

Agent skills are reusable Markdown instructions that extend what your app's AI agents know how to do. Use these commands to manage them.

Note: Agent skill commands perform full synchronization - pushing replaces all remote skills with local ones, and pulling replaces all local skills with remote ones.

Agent Skill Schema (Quick Reference)

File naming: base44/agent-skills/{skill-name}.md (e.g., pdf-export.md)

Schema template:

---
description: Export the current report as a PDF and attach it to the conversation.
---

Use this skill when the user asks to export, download, or share a report as a PDF.

1. Call the `generate_report_pdf` function with the current report's entity ID.
2. Attach the returned file URL in your reply.

Naming rules: Skill names (the file name minus .md) must match pattern /^[a-z0-9]+(-[a-z0-9]+)*$/ (lowercase, hyphen-separated, 1-64 chars)

• Valid: pdf-export, order-lookup
• Invalid: PdfExport, pdf_export

Required fields: description (frontmatter, 1-1024 chars), body (Markdown content, 1-15000 chars)

For complete documentation, see agent-skills-push.md.

Connector Management

Connectors let your app connect to external services (Google Calendar, Slack, Stripe, etc.). Most connectors use OAuth to provide access tokens for backend functions to call external APIs. Stripe is the exception — it is provisioned automatically on the server side with no OAuth browser flow.

Note: Connector commands perform full synchronization - pushing replaces all remote connectors with local ones (and triggers OAuth for new OAuth connectors), and pulling replaces all local connectors with remote ones.

Connector Schema (Quick Reference)

File naming: base44/connectors/{type}.jsonc (e.g., googlecalendar.jsonc, slack.jsonc)

Schema template:

{
  "type": "googlecalendar",
  "scopes": [
    "https://www.googleapis.com/auth/calendar.readonly",
    "https://www.googleapis.com/auth/calendar.events"
  ]
}

Required fields: type Optional fields: scopes (defaults to [])

Available connector types: Run npx base44 connectors list-available to see all supported integration types.

Note: stripe is also a valid connector type but is not returned by list-available. Treat it as a supported type — it is provisioned automatically by Base44 with no OAuth browser flow. See connectors-create.md for details.

For complete documentation, see connectors-create.md.

Auth Configuration

Manage your app's authentication settings (e.g., username & password login). Auth config is stored in base44/auth/ and synced with Base44 via auth push/auth pull.

Note: Auth config is also deployed as part of base44 deploy.

Secrets Management

Manage project secrets (environment variables stored securely in Base44). These commands are hidden from --help output but are fully functional.

Script Execution

Run one-off scripts against your app with the Base44 SDK pre-authenticated. Use it to perform CRUD operations on entities (base44.entities.MyEntity.list/create/update/delete), call backend functions (base44.functions.invoke("myFunction", args)), invoke agents, or access any other resource exposed by the SDK — without deploying a full function. Useful for data migrations, bulk operations, debugging, and scripted workflows.

Type Generation

Output: base44/.types/types.d.ts — augments @base44/sdk module with typed registries (EntityTypeRegistry, FunctionNameRegistry, AgentNameRegistry, ConnectorTypeRegistry).

No authentication required. Runs entirely locally. Automatically updates tsconfig.json to include the generated types.

Site Management

SPA only: Base44 hosting supports Single Page Applications with a single index.html entry point. All routes are served from index.html (client-side routing).

Quick Start

1. Install the CLI in your project:

   npm install --save-dev base44

1. Authenticate with Base44:

   npx base44 login

1. Create a new project (ALWAYS provide name and --path flag):

   npx base44 create my-app --path .

1. Run local development:

   npx base44 dev

1. Build and deploy everything:

   npx base44 deploy --build -y

Or deploy individual resources:

• npx base44 entities push - Push entities only
• npx base44 functions deploy - Deploy functions only
• npx base44 functions delete <name> - Delete a deployed function
• npx base44 functions list - List all deployed functions
• npx base44 functions pull - Pull deployed functions to local files
• npx base44 agents push - Push agents only
• npx base44 agent-skills push - Push agent skills only
• npx base44 connectors pull - Pull connectors from Base44
• npx base44 connectors push - Push connectors only
• npx base44 auth pull - Pull auth config from Base44
• npx base44 auth push - Push auth config only
• npx base44 site deploy -y - Deploy site only

Common Workflows

Creating a New Project

⚠️ MANDATORY: Before running `base44 create`, you MUST read [create.md](references/create.md) for:

• Template selection - Choose the correct template (backend-and-client vs backend-only)
• Correct workflow - Different templates require different setup steps
• Common pitfalls - Avoid folder creation errors that cause failures

Failure to follow the create.md instructions will result in broken project scaffolding.

Linking an Existing Project

# If you have base44/config.jsonc but no .app.jsonc
npx base44 link --create --name my-app

Running Local Development

Always run through the CLI — two modes:

base44 dev starts the local backend (entities, functions, auth) and also serves your frontend when base44/config.jsonc sets site.serveCommand; a backend-only project needs nothing else. --remote runs only the frontend against the real backend, so it needs both a linked project and site.serveCommand.

Don't run npm run dev yourself: without the env vars the CLI injects, the app has no backend to reach — the dev server prints which command to use instead.

Default to `npx base44 dev`. Under --remote every write hits the live app. The vite startup line names the backend either way: [base44] Proxy enabled: /api -> <target>. Say which you started. Options: dev.md.

Deploying All Changes

# Generate types (optional, for TypeScript projects)
npx base44 types generate

# Deploy everything (entities, functions, and site), building the site first
npx base44 deploy --build -y

Build through the CLI, not with npm run build: npx base44 build injects VITE_BASE44_APP_ID, which a bare npm run build leaves unset — the bundle then can't resolve its own app and every API call on the deployed site fails. npx base44 deploy asks whether to build first; --build / --no-build answers up front (non-interactive defaults to upload-only, so CI is unchanged).

Generating TypeScript Types

# Generate types from entities, functions, agents, and connectors
npx base44 types generate

This creates base44/.types/types.d.ts with typed registries for the @base44/sdk module. Run this after changing entities, functions, agents, or connectors to keep your types in sync. No authentication required.

Deploying Individual Resources

# Push only entities
npx base44 entities push

# Deploy only functions (all)
npx base44 functions deploy
# Deploy specific functions
npx base44 functions deploy my-function other-function
# Deploy and prune removed functions
npx base44 functions deploy --force

# Push only agents
npx base44 agents push

# Push only agent skills
npx base44 agent-skills push

# Pull connectors from Base44
npx base44 connectors pull

# Push only connectors
npx base44 connectors push

# Deploy only site
npx base44 site deploy -y

Opening the Dashboard

# Open app dashboard in browser
npx base44 dashboard

Authentication

Most commands require authentication. If you're not logged in, the CLI will automatically prompt you to login. Your session is stored locally and persists across CLI sessions.

Troubleshooting