@base44-preview/cli 0.0.14-pr.92.59cf482 → 0.0.14-pr.93.54ecdc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +40 -138
  2. package/dist/cli/index.js +1952 -2040
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,174 +1,76 @@
1
1
  # Base44 CLI
2
2
 
3
- A unified command-line interface for managing Base44 applications, entities, functions, deployments, and related services.
3
+ Command-line interface for building applications with [Base44's backend service](https://docs.base44.com/developers/backend/overview/introduction).
4
4
 
5
- **Zero dependencies** - installs in seconds with no dependency resolution.
5
+ Base44's backend service provides a managed backend for your applications — data storage with entities, serverless functions, authentication, and hosting. The CLI lets you:
6
+
7
+ - **Create projects** from templates (backend-only or full-stack React)
8
+ - **Sync** entities and functions defined in local code with your Base44 backend
9
+ - **Deploy sites** to Base44's hosting platform
10
+
11
+ 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).
6
12
 
7
13
  ## Installation
8
14
 
9
15
  ```bash
10
- # Using npm (globally)
11
16
  npm install -g base44
12
-
13
- # Or run directly with npx
14
- npx base44 <command>
15
17
  ```
16
18
 
17
- ## Quick Start
19
+ Or run commands directly with npx:
18
20
 
19
21
  ```bash
20
- # 1. Login to Base44
21
- base44 login
22
-
23
- # 2. Create a new project
24
- base44 create
25
-
26
- # 3. Deploy everything (entities, functions, and site)
27
- npm run build
28
- base44 deploy
29
- ```
30
-
31
- ## Commands
32
-
33
- ### Authentication
34
-
35
- | Command | Description |
36
- |---------|-------------|
37
- | `base44 login` | Authenticate with Base44 using device code flow |
38
- | `base44 whoami` | Display current authenticated user |
39
- | `base44 logout` | Logout from current device |
40
-
41
- ### Project Management
42
-
43
- | Command | Description |
44
- |---------|-------------|
45
- | `base44 create` | Create a new Base44 project from a template |
46
- | `base44 link` | Link an existing local project to Base44 |
47
- | `base44 dashboard` | Open the app dashboard in your browser |
48
-
49
- ### Deployment
50
-
51
- | Command | Description |
52
- |---------|-------------|
53
- | `base44 deploy` | Deploy all resources (entities, functions, and site) |
54
-
55
- ### Entities
56
-
57
- | Command | Description |
58
- |---------|-------------|
59
- | `base44 entities push` | Push local entity schemas to Base44 |
60
-
61
- ### Functions
62
-
63
- | Command | Description |
64
- |---------|-------------|
65
- | `base44 functions deploy` | Deploy local functions to Base44 |
66
-
67
- ### Site
68
-
69
- | Command | Description |
70
- |---------|-------------|
71
- | `base44 site deploy` | Deploy built site files to Base44 hosting |
72
-
73
- ## Configuration
74
-
75
- ### Project Configuration
76
-
77
- Base44 projects are configured via a `config.jsonc` (or `config.json`) file in the `base44/` subdirectory:
78
-
79
- ```jsonc
80
- // base44/config.jsonc
81
- {
82
- "id": "your-app-id", // Set after project creation
83
- "name": "My Project",
84
- "entitiesDir": "./entities", // Default: ./entities
85
- "functionsDir": "./functions", // Default: ./functions
86
- "site": {
87
- "outputDirectory": "../dist" // Path to built site files
88
- }
89
- }
22
+ npx base44 <command>
90
23
  ```
91
24
 
92
- ### Environment Variables
93
-
94
- | Variable | Description | Default |
95
- |----------|-------------|---------|
96
- | `BASE44_CLIENT_ID` | Your app ID | - |
25
+ Requires Node.js 20.19.0 or higher.
97
26
 
98
- You can set these in a `.env.local` file in your `base44/` directory:
27
+ ## Quick start
99
28
 
100
29
  ```bash
101
- # base44/.env.local
102
- BASE44_CLIENT_ID=your-app-id
103
- ```
104
-
105
- ## Project Structure
106
-
107
- A typical Base44 project has this structure:
30
+ # Authenticate
31
+ base44 login
108
32
 
109
- ```
110
- my-project/
111
- ├── base44/
112
- │ ├── config.jsonc # Project configuration
113
- │ ├── .env.local # Environment variables (git-ignored)
114
- │ ├── entities/ # Entity schema files
115
- │ │ ├── user.jsonc
116
- │ │ └── product.jsonc
117
- │ └── functions/ # Backend functions
118
- │ └── my-function/
119
- │ ├── config.jsonc
120
- │ └── index.js
121
- ├── src/ # Your frontend code
122
- ├── dist/ # Built site files (for deployment)
123
- └── package.json
33
+ # Create a project
34
+ base44 create
124
35
  ```
125
36
 
126
- ## Development
37
+ The CLI will guide you through project setup. For step-by-step tutorials, see the quickstart guides:
127
38
 
128
- ### Prerequisites
39
+ - [Backend only](https://docs.base44.com/developers/backend/quickstart/quickstart-backend-only) — for headless apps or custom frontends
40
+ - [React](https://docs.base44.com/developers/backend/quickstart/quickstart-with-react) — full-stack with Vite + React
129
41
 
130
- - Node.js >= 20.19.0
131
- - npm
42
+ ## Commands
132
43
 
133
- ### Setup
44
+ | Command | Description |
45
+ | ------- | ----------- |
46
+ | [`create`](https://docs.base44.com/developers/references/cli/commands/create) | Create a new Base44 project from a template |
47
+ | [`link`](https://docs.base44.com/developers/references/cli/commands/link) | Link a local project to a project on Base44 |
48
+ | [`dashboard`](https://docs.base44.com/developers/references/cli/commands/dashboard) | Open the app dashboard in your browser |
49
+ | [`login`](https://docs.base44.com/developers/references/cli/commands/login) | Authenticate with Base44 |
50
+ | [`logout`](https://docs.base44.com/developers/references/cli/commands/logout) | Sign out and clear stored credentials |
51
+ | [`whoami`](https://docs.base44.com/developers/references/cli/commands/whoami) | Display the current authenticated user |
52
+ | [`entities push`](https://docs.base44.com/developers/references/cli/commands/entities-push) | Push local entity schemas to Base44 |
53
+ | [`functions deploy`](https://docs.base44.com/developers/references/cli/commands/functions-deploy) | Deploy local functions to Base44 |
54
+ | [`site deploy`](https://docs.base44.com/developers/references/cli/commands/site-deploy) | Deploy built site files to Base44 hosting |
55
+
56
+ ## Help
134
57
 
135
58
  ```bash
136
- # Clone the repository
137
- git clone https://github.com/base44/cli.git
138
- cd cli
139
-
140
- # Install dependencies
141
- npm install
142
-
143
- # Build
144
- npm run build
145
-
146
- # Run in development mode
147
- npm run dev -- <command>
59
+ base44 --help
60
+ base44 <command> --help
148
61
  ```
149
62
 
150
- ### Available Scripts
63
+ ## Version
151
64
 
152
65
  ```bash
153
- npm run build # Build with tsdown
154
- npm run typecheck # Type check with tsc
155
- npm run dev # Run in development mode with tsx
156
- npm run lint # Lint with ESLint
157
- npm test # Run tests with Vitest
66
+ base44 --version
158
67
  ```
159
68
 
160
- ### Running the Built CLI
69
+ ## Alpha
161
70
 
162
- ```bash
163
- # After building
164
- npm start -- <command>
165
-
166
- # Or directly
167
- ./dist/cli/index.js <command>
168
- ```
169
- ## Contributing
71
+ 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 [feedback board](https://feedback.base44.com/roadmap).
170
72
 
171
- See [AGENTS.md](./AGENTS.md) for development guidelines and architecture documentation.
73
+ Found a bug? [Open an issue](https://github.com/base44/cli/issues).
172
74
 
173
75
  ## License
174
76