@onexapis/cli 1.0.4 → 1.1.1
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.
- package/README.md +65 -63
- package/dist/cli.js +1150 -105
- package/dist/cli.js.map +1 -1
- package/dist/cli.mjs +1125 -103
- package/dist/cli.mjs.map +1 -1
- package/dist/index.d.mts +2 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +1018 -237
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +852 -90
- package/dist/index.mjs.map +1 -1
- package/dist/preview/preview-app.tsx +368 -0
- package/package.json +7 -2
package/README.md
CHANGED
|
@@ -47,22 +47,22 @@ onex clone simple
|
|
|
47
47
|
|
|
48
48
|
Create a new OneX theme project from a template.
|
|
49
49
|
|
|
50
|
-
| Option
|
|
51
|
-
|
|
50
|
+
| Option | Description |
|
|
51
|
+
| --------------------------- | -------------------------------------- |
|
|
52
52
|
| `-t, --template <template>` | Template to use (`default`, `minimal`) |
|
|
53
|
-
| `--no-install`
|
|
54
|
-
| `--git`
|
|
55
|
-
| `-y, --yes`
|
|
53
|
+
| `--no-install` | Skip installing dependencies |
|
|
54
|
+
| `--git` | Initialize a git repository |
|
|
55
|
+
| `-y, --yes` | Skip prompts and use defaults |
|
|
56
56
|
|
|
57
57
|
### `onex create:section <name>` (alias: `cs`)
|
|
58
58
|
|
|
59
59
|
Scaffold a new section inside a theme.
|
|
60
60
|
|
|
61
|
-
| Option
|
|
62
|
-
|
|
63
|
-
| `-t, --theme <theme>`
|
|
61
|
+
| Option | Description |
|
|
62
|
+
| --------------------------- | -------------------------------------------------- |
|
|
63
|
+
| `-t, --theme <theme>` | Target theme |
|
|
64
64
|
| `-c, --category <category>` | Section category (`headers`, `content`, `footers`) |
|
|
65
|
-
| `--template <template>`
|
|
65
|
+
| `--template <template>` | Initial template variant (`default`, `minimal`) |
|
|
66
66
|
|
|
67
67
|
```bash
|
|
68
68
|
onex create:section hero -t my-theme -c heroes
|
|
@@ -73,8 +73,8 @@ onex cs featured-products -t my-store
|
|
|
73
73
|
|
|
74
74
|
Scaffold a new block.
|
|
75
75
|
|
|
76
|
-
| Option
|
|
77
|
-
|
|
76
|
+
| Option | Description |
|
|
77
|
+
| --------------------- | ----------------------- |
|
|
78
78
|
| `-t, --theme <theme>` | Target theme (optional) |
|
|
79
79
|
|
|
80
80
|
```bash
|
|
@@ -86,8 +86,8 @@ onex cb testimonial-item -t my-theme
|
|
|
86
86
|
|
|
87
87
|
Scaffold a new UI component.
|
|
88
88
|
|
|
89
|
-
| Option
|
|
90
|
-
|
|
89
|
+
| Option | Description |
|
|
90
|
+
| ------------------- | --------------------------------------- |
|
|
91
91
|
| `-t, --type <type>` | Component type (`ui`, `layout`, `form`) |
|
|
92
92
|
|
|
93
93
|
```bash
|
|
@@ -99,33 +99,34 @@ onex cc custom-input -t form
|
|
|
99
99
|
|
|
100
100
|
List available themes, sections, blocks, and components in the project.
|
|
101
101
|
|
|
102
|
-
| Option
|
|
103
|
-
|
|
104
|
-
| `-s, --sections`
|
|
105
|
-
| `-b, --blocks`
|
|
106
|
-
| `-c, --components`
|
|
107
|
-
| `-t, --theme <theme>` | Filter by theme
|
|
102
|
+
| Option | Description |
|
|
103
|
+
| --------------------- | -------------------- |
|
|
104
|
+
| `-s, --sections` | List sections only |
|
|
105
|
+
| `-b, --blocks` | List blocks only |
|
|
106
|
+
| `-c, --components` | List components only |
|
|
107
|
+
| `-t, --theme <theme>` | Filter by theme |
|
|
108
108
|
|
|
109
109
|
### `onex validate`
|
|
110
110
|
|
|
111
111
|
Validate theme structure and files.
|
|
112
112
|
|
|
113
|
-
| Option
|
|
114
|
-
|
|
115
|
-
| `-t, --theme <theme>` | Theme to validate
|
|
116
|
-
| `-f, --fix`
|
|
113
|
+
| Option | Description |
|
|
114
|
+
| --------------------- | ------------------------------------- |
|
|
115
|
+
| `-t, --theme <theme>` | Theme to validate |
|
|
116
|
+
| `-f, --fix` | Auto-fix issues (not yet implemented) |
|
|
117
117
|
|
|
118
118
|
### `onex build`
|
|
119
119
|
|
|
120
120
|
Build a theme for production. Runs type-check, lint, and compilation.
|
|
121
121
|
|
|
122
|
-
| Option
|
|
123
|
-
|
|
124
|
-
| `-t, --theme <theme>` | Theme to build
|
|
125
|
-
| `-p, --production`
|
|
126
|
-
| `-w, --watch`
|
|
122
|
+
| Option | Description |
|
|
123
|
+
| --------------------- | ----------------------------------- |
|
|
124
|
+
| `-t, --theme <theme>` | Theme to build |
|
|
125
|
+
| `-p, --production` | Production build with optimizations |
|
|
126
|
+
| `-w, --watch` | Watch mode for development |
|
|
127
127
|
|
|
128
128
|
> **Note:** The theme's `package.json` must have `type-check` and `lint` scripts for the build to pass. Example:
|
|
129
|
+
>
|
|
129
130
|
> ```json
|
|
130
131
|
> { "scripts": { "type-check": "tsc --noEmit", "lint": "eslint src" } }
|
|
131
132
|
> ```
|
|
@@ -134,39 +135,39 @@ Build a theme for production. Runs type-check, lint, and compilation.
|
|
|
134
135
|
|
|
135
136
|
Compile and package a theme as a distributable zip file.
|
|
136
137
|
|
|
137
|
-
| Option
|
|
138
|
-
|
|
139
|
-
| `-t, --theme <theme>` | Theme to package
|
|
140
|
-
| `-o, --output <dir>`
|
|
141
|
-
| `-n, --name <name>`
|
|
142
|
-
| `-m, --minify`
|
|
143
|
-
| `--skip-build`
|
|
138
|
+
| Option | Description |
|
|
139
|
+
| --------------------- | --------------------------------------------- |
|
|
140
|
+
| `-t, --theme <theme>` | Theme to package |
|
|
141
|
+
| `-o, --output <dir>` | Output directory |
|
|
142
|
+
| `-n, --name <name>` | Custom package name |
|
|
143
|
+
| `-m, --minify` | Minify compiled output |
|
|
144
|
+
| `--skip-build` | Skip compilation, use existing compiled theme |
|
|
144
145
|
|
|
145
146
|
### `onex deploy`
|
|
146
147
|
|
|
147
148
|
Upload a theme package to the API server.
|
|
148
149
|
|
|
149
|
-
| Option
|
|
150
|
-
|
|
151
|
-
| `-t, --theme <theme>`
|
|
152
|
-
| `-p, --package <file>`
|
|
153
|
-
| `--api-url <url>`
|
|
154
|
-
| `-k, --api-key <key>`
|
|
150
|
+
| Option | Description |
|
|
151
|
+
| ------------------------- | ---------------------------------------------------- |
|
|
152
|
+
| `-t, --theme <theme>` | Theme to deploy |
|
|
153
|
+
| `-p, --package <file>` | Specific package file to upload |
|
|
154
|
+
| `--api-url <url>` | API server URL (default: `http://localhost:3001`) |
|
|
155
|
+
| `-k, --api-key <key>` | API key for authentication |
|
|
155
156
|
| `-e, --environment <env>` | Environment (`production`, `staging`, `development`) |
|
|
156
157
|
|
|
157
158
|
### `onex upload`
|
|
158
159
|
|
|
159
160
|
Upload compiled theme to S3 as `bundle.zip` + `source.zip`.
|
|
160
161
|
|
|
161
|
-
| Option
|
|
162
|
-
|
|
163
|
-
| `-t, --theme <theme>`
|
|
164
|
-
| `-b, --bucket <name>`
|
|
165
|
-
| `-v, --version <version>` | Theme version
|
|
166
|
-
| `-e, --environment <env>` | Environment (`staging` or `production`)
|
|
167
|
-
| `--dry-run`
|
|
168
|
-
| `--skip-source`
|
|
169
|
-
| `--source-dir <dir>`
|
|
162
|
+
| Option | Description |
|
|
163
|
+
| ------------------------- | --------------------------------------------- |
|
|
164
|
+
| `-t, --theme <theme>` | Theme to upload |
|
|
165
|
+
| `-b, --bucket <name>` | S3 bucket name |
|
|
166
|
+
| `-v, --version <version>` | Theme version |
|
|
167
|
+
| `-e, --environment <env>` | Environment (`staging` or `production`) |
|
|
168
|
+
| `--dry-run` | Show what would be uploaded without uploading |
|
|
169
|
+
| `--skip-source` | Skip uploading `source.zip` |
|
|
170
|
+
| `--source-dir <dir>` | Source directory path |
|
|
170
171
|
|
|
171
172
|
```bash
|
|
172
173
|
# Dry run first
|
|
@@ -186,25 +187,25 @@ onex upload --theme simple --bucket custom-bucket
|
|
|
186
187
|
|
|
187
188
|
Download a compiled theme from S3.
|
|
188
189
|
|
|
189
|
-
| Option
|
|
190
|
-
|
|
191
|
-
| `-t, --theme-id <id>`
|
|
192
|
-
| `-v, --version <version>` | Theme version (default: `latest`)
|
|
193
|
-
| `-b, --bucket <name>`
|
|
194
|
-
| `-e, --environment <env>` | Environment (`staging` or `production`)
|
|
195
|
-
| `-o, --output <dir>`
|
|
190
|
+
| Option | Description |
|
|
191
|
+
| ------------------------- | -------------------------------------------- |
|
|
192
|
+
| `-t, --theme-id <id>` | Theme ID to download |
|
|
193
|
+
| `-v, --version <version>` | Theme version (default: `latest`) |
|
|
194
|
+
| `-b, --bucket <name>` | S3 bucket name |
|
|
195
|
+
| `-e, --environment <env>` | Environment (`staging` or `production`) |
|
|
196
|
+
| `-o, --output <dir>` | Output directory (default: `./active-theme`) |
|
|
196
197
|
|
|
197
198
|
### `onex clone <theme-name>`
|
|
198
199
|
|
|
199
200
|
Clone theme source code from S3.
|
|
200
201
|
|
|
201
|
-
| Option
|
|
202
|
-
|
|
203
|
-
| `-v, --version <version>` | Theme version (default: `latest`)
|
|
204
|
-
| `-o, --output <dir>`
|
|
205
|
-
| `-b, --bucket <name>`
|
|
202
|
+
| Option | Description |
|
|
203
|
+
| ------------------------- | --------------------------------------- |
|
|
204
|
+
| `-v, --version <version>` | Theme version (default: `latest`) |
|
|
205
|
+
| `-o, --output <dir>` | Output directory |
|
|
206
|
+
| `-b, --bucket <name>` | S3 bucket name |
|
|
206
207
|
| `-e, --environment <env>` | Environment (`staging` or `production`) |
|
|
207
|
-
| `--no-install`
|
|
208
|
+
| `--no-install` | Skip running `pnpm install` after clone |
|
|
208
209
|
|
|
209
210
|
```bash
|
|
210
211
|
onex clone simple
|
|
@@ -262,6 +263,7 @@ ADAPTER_MODE=local
|
|
|
262
263
|
### Bucket Name Resolution
|
|
263
264
|
|
|
264
265
|
Priority order:
|
|
266
|
+
|
|
265
267
|
1. `--bucket` CLI flag
|
|
266
268
|
2. `BUCKET_NAME` environment variable
|
|
267
269
|
3. Default: `onex-themes-staging` or `onex-themes-prod` (based on `--environment`)
|