base44 0.0.1 → 0.0.2

package/README.md

@@ -2,71 +2,145 @@
 
 A unified command-line interface for managing Base44 applications, entities, functions, deployments, and related services.
 
+**Zero dependencies** - installs in seconds with no dependency resolution.
+
 ## Installation
 
 ```bash
-# Using npm
-npm install
-
-# Build the project
-npm run build
+# Using npm (globally)
+npm install -g base44
 
-# Run the CLI (multiple ways)
-npm start                     # Using node directly
-npm run base44                # Using npm (runs node_modules/.bin/base44)
-./dist/cli/index.js          # Run executable directly
+# Or run directly with npx
+npx base44 <command>
 ```
 
-## Development
+## Quick Start
 
 ```bash
-# Run in development mode with watch
-npm run dev
+# 1. Login to Base44
+base44 login
 
-# Build the project
-npm run build
+# 2. Create a new project
+base44 create
 
-# Clean build artifacts
-npm run clean
+# 3. Push entities to Base44
+base44 entities push
 ```
 
 ## Commands
 
 ### Authentication
-- `base44 login` - Authenticate with Base44
-- `base44 whoami` - Display current authenticated user
-- `base44 logout` - Logout from current device
+
+| 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 |
+
+### Entities
+
+| Command | Description |
+|---------|-------------|
+| `base44 entities push` | Push local entity schemas to Base44 |
+
+## 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
+}
+```
+
+### Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `BASE44_CLIENT_ID` | Your app ID | - |
+
+You can set these in a `.env.local` file in your `base44/` directory:
+
+```bash
+# base44/.env.local
+BASE44_CLIENT_ID=your-app-id
+```
 
 ## Project Structure
 
+A typical Base44 project has this structure:
+
 ```
-cli/
-├── src/
-│   ├── core/                    # Core module (shared code)
-│   │   ├── api/                # API client code
-│   │   ├── config/             # Configuration management
-│   │   ├── schemas/            # Zod schemas
-│   │   ├── utils/              # Utility functions
-│   │   └── index.ts            # Core module exports
-│   └── cli/                     # CLI module (main CLI)
-│       ├── commands/            # Command implementations
-│       │   └── auth/           # Authentication commands
-│       ├── utils/               # CLI-specific utilities
-│       └── index.ts             # Main CLI entry point (with shebang)
-├── dist/                        # Build output (compiled JavaScript)
-├── package.json                 # Package configuration
-├── tsconfig.json                # TypeScript configuration
-└── README.md
+my-project/
+├── base44/
+│   ├── config.jsonc           # Project configuration
+│   ├── .env.local             # Environment variables (git-ignored)
+│   ├── entities/              # Entity schema files
+│   │   ├── user.jsonc
+│   │   └── product.jsonc
+├── src/                       # Your frontend code
+└── package.json
 ```
 
-## Technologies
+## Development
+
+### Prerequisites
+
+- Node.js >= 20.19.0
+- npm
+
+### Setup
+
+```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>
+```
+
+### Available Scripts
+
+```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
+```
 
-- **TypeScript** - Primary language
-- **Commander.js** - CLI framework
-- **@clack/prompts** - Interactive user prompts
-- **Zod** - Schema validation
+### Running the Built CLI
+
+```bash
+# After building
+npm start -- <command>
+
+# Or directly
+./dist/cli/index.js <command>
+```
+## Contributing
+
+See [AGENTS.md](./AGENTS.md) for development guidelines and architecture documentation.
 
 ## License
 
 ISC
-