@base44-preview/cli 0.0.14-pr.92.59cf482 → 0.0.15-pr.93.4af3300

package/README.md

@@ -1,174 +1,78 @@
 # Base44 CLI
 
-A unified command-line interface for managing Base44 applications, entities, functions, deployments, and related services.
+Command-line interface for building applications with [Base44's backend service](https://docs.base44.com/developers/backend/overview/introduction).
 
-**Zero dependencies** - installs in seconds with no dependency resolution.
+Base44's backend service provides a managed backend for your applications, including data storage with entities, serverless functions, authentication, and hosting. The CLI lets you:
+
+- **Create projects** from templates.
+- **Sync** resources defined in local code with your Base44 backend.
+- **Deploy sites** to Base44's hosting platform.
+
+To get started, see the full list of commands below or check out the [documentation](https://docs.base44.com/developers/references/cli/get-started/overview).
 
 ## Installation
 
 ```bash
-# Using npm (globally)
 npm install -g base44
-
-# Or run directly with npx
-npx base44 <command>
 ```
 
-## Quick Start
+Or run commands directly with npx:
 
 ```bash
-# 1. Login to Base44
-base44 login
-
-# 2. Create a new project
-base44 create
-
-# 3. Deploy everything (entities, functions, and site)
-npm run build
-base44 deploy
-```
-
-## Commands
-
-### Authentication
-
-| Command | Description |
-|---------|-------------|
-| `base44 login` | Authenticate with Base44 using device code flow |
-| `base44 whoami` | Display current authenticated user |
-| `base44 logout` | Logout from current device |
-
-### Project Management
-
-| Command | Description |
-|---------|-------------|
-| `base44 create` | Create a new Base44 project from a template |
-| `base44 link` | Link an existing local project to Base44 |
-| `base44 dashboard` | Open the app dashboard in your browser |
-
-### Deployment
-
-| Command | Description |
-|---------|-------------|
-| `base44 deploy` | Deploy all resources (entities, functions, and site) |
-
-### Entities
-
-| Command | Description |
-|---------|-------------|
-| `base44 entities push` | Push local entity schemas to Base44 |
-
-### Functions
-
-| Command | Description |
-|---------|-------------|
-| `base44 functions deploy` | Deploy local functions to Base44 |
-
-### Site
-
-| Command | Description |
-|---------|-------------|
-| `base44 site deploy` | Deploy built site files to Base44 hosting |
-
-## Configuration
-
-### Project Configuration
-
-Base44 projects are configured via a `config.jsonc` (or `config.json`) file in the `base44/` subdirectory:
-
-```jsonc
-// base44/config.jsonc
-{
-  "id": "your-app-id",           // Set after project creation
-  "name": "My Project",
-  "entitiesDir": "./entities",   // Default: ./entities
-  "functionsDir": "./functions", // Default: ./functions
-  "site": {
-    "outputDirectory": "../dist" // Path to built site files
-  }
-}
+npx base44 <command>
 ```
 
-### Environment Variables
-
-| Variable | Description | Default |
-|----------|-------------|---------|
-| `BASE44_CLIENT_ID` | Your app ID | - |
+Requires Node.js 20.19.0 or higher.
 
-You can set these in a `.env.local` file in your `base44/` directory:
+## Quick start
 
 ```bash
-# base44/.env.local
-BASE44_CLIENT_ID=your-app-id
-```
-
-## Project Structure
-
-A typical Base44 project has this structure:
+# Authenticate
+base44 login
 
-```
-my-project/
-├── base44/
-│   ├── config.jsonc           # Project configuration
-│   ├── .env.local             # Environment variables (git-ignored)
-│   ├── entities/              # Entity schema files
-│   │   ├── user.jsonc
-│   │   └── product.jsonc
-│   └── functions/             # Backend functions
-│       └── my-function/
-│           ├── config.jsonc
-│           └── index.js
-├── src/                       # Your frontend code
-├── dist/                      # Built site files (for deployment)
-└── package.json
+# Create a project
+base44 create
 ```
 
-## Development
+The CLI will guide you through project setup. For step-by-step tutorials, see the quickstart guides:
 
-### Prerequisites
+- [Backend only](https://docs.base44.com/developers/backend/quickstart/quickstart-backend-only) — for headless apps or custom frontends
+- [React](https://docs.base44.com/developers/backend/quickstart/quickstart-with-react) — full-stack with Vite + React
 
-- Node.js >= 20.19.0
-- npm
+## Commands
 
-### Setup
+| Command | Description |
+| ------- | ----------- |
+| [`create`](https://docs.base44.com/developers/references/cli/commands/create) | Create a new Base44 project from a template |
+| [`deploy`](https://docs.base44.com/developers/references/cli/commands/deploy) | Deploy resources and site to Base44 |
+| [`eject`](https://docs.base44.com/developers/references/cli/commands/eject) | Create a Base44 backend project from an existing Base44 app |
+| [`link`](https://docs.base44.com/developers/references/cli/commands/link) | Link a local project to a project on Base44 |
+| [`dashboard`](https://docs.base44.com/developers/references/cli/commands/dashboard) | Open the app dashboard in your browser |
+| [`login`](https://docs.base44.com/developers/references/cli/commands/login) | Authenticate with Base44 |
+| [`logout`](https://docs.base44.com/developers/references/cli/commands/logout) | Sign out and clear stored credentials |
+| [`whoami`](https://docs.base44.com/developers/references/cli/commands/whoami) | Display the current authenticated user |
+| [`entities push`](https://docs.base44.com/developers/references/cli/commands/entities-push) | Push local entity schemas to Base44 |
+| [`functions deploy`](https://docs.base44.com/developers/references/cli/commands/functions-deploy) | Deploy local functions to Base44 |
+| [`site deploy`](https://docs.base44.com/developers/references/cli/commands/site-deploy) | Deploy built site files to Base44 hosting |
+
+## Help
 
 ```bash
-# Clone the repository
-git clone https://github.com/base44/cli.git
-cd cli
-
-# Install dependencies
-npm install
-
-# Build
-npm run build
-
-# Run in development mode
-npm run dev -- <command>
+base44 --help
+base44 <command> --help
 ```
 
-### Available Scripts
+## Version
 
 ```bash
-npm run build      # Build with tsdown
-npm run typecheck  # Type check with tsc
-npm run dev        # Run in development mode with tsx
-npm run lint       # Lint with ESLint
-npm test           # Run tests with Vitest
+base44 --version
 ```
 
-### Running the Built CLI
+## Alpha
 
-```bash
-# After building
-npm start -- <command>
-
-# Or directly
-./dist/cli/index.js <command>
-```
-## Contributing
+The CLI and Base44 backend service are currently in alpha. We're actively improving them based on user feedback. Share your thoughts and feature requests on our [GitHub Discussions](https://github.com/orgs/base44/discussions).
 
-See [AGENTS.md](./AGENTS.md) for development guidelines and architecture documentation.
+Found a bug? [Open an issue](https://github.com/base44/cli/issues).
 
 ## License