@solidxai/solidctl 0.1.14-beta.0 → 0.1.15

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 (2) hide show
  1. package/README.md +187 -66
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,98 +1,219 @@
1
- <p align="center">
2
- <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
3
- </p>
4
-
5
- [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
6
- [circleci-url]: https://circleci.com/gh/nestjs/nest
7
-
8
- <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
9
- <p align="center">
10
- <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
11
- <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
12
- <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
13
- <a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
14
- <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
15
- <a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
16
- <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
17
- <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
18
- <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
19
- <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
20
- </p>
21
- <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
22
- [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
23
-
24
- ## Description
25
-
26
- [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
27
-
28
- ## Project setup
1
+ # solidctl
2
+
3
+ > The developer CLI for the SolidX platform — scaffold, build, seed, generate, and release your SolidX application from a single tool.
4
+
5
+ `solidctl` is the command-line interface that ties the SolidX ecosystem together. Whether you are starting a new project, upgrading core dependencies, or regenerating code after a model change using the command line, `solidctl` is the entry point.
6
+
7
+ [![npm version](https://img.shields.io/npm/v/@solidxai/solidctl)](https://www.npmjs.com/package/@solidxai/solidctl)
8
+ [![License: BSL-1.1](https://img.shields.io/badge/License-BSL--1.1-blue.svg)](https://opensource.org/licenses/BSL-1.1)
9
+ [![Documentation](https://img.shields.io/badge/docs-solidxai.com-blue)](https://docs.solidxai.com/docs)
10
+
11
+ ---
12
+
13
+ ## Usage
14
+
15
+ The recommended way to run `solidctl` is via `npx`, which ensures you are always using the latest version without needing a global install:
29
16
 
30
17
  ```bash
31
- $ npm install
18
+ npx @solidxai/solidctl <command>
32
19
  ```
33
20
 
34
- ## Compile and run the project
21
+ All examples in this README use `npx`. If you prefer a global install:
35
22
 
36
23
  ```bash
37
- # development
38
- $ npm run start
24
+ npm install -g @solidxai/solidctl
25
+ solidctl <command>
26
+ ```
27
+
28
+ However please note that a global install may become outdated, so we recommend using `npx` for the best experience.
29
+
30
+ ---
39
31
 
40
- # watch mode
41
- $ npm run start:dev
32
+ ## Quick start
42
33
 
43
- # production mode
44
- $ npm run start:prod
34
+ Scaffold a new SolidX project with a single command:
35
+
36
+ ```bash
37
+ npx @solidxai/solidctl create-app
38
+ ```
39
+
40
+ The interactive wizard will ask for your project name, database connection details, and port configuration, then scaffold a complete project structure:
41
+
42
+ ```
43
+ my-solid-app/
44
+ ├── solid-api/ # NestJS backend powered by @solidxai/core
45
+ └── solid-ui/ # React frontend powered by @solidxai/core-ui
45
46
  ```
46
47
 
47
- ## Run tests
48
+ Once created, build the API and bootstrap the database:
48
49
 
49
50
  ```bash
50
- # unit tests
51
- $ npm run test
51
+ cd my-solid-app
52
+ npx @solidxai/solidctl build # compiles solid-api and sets up the local solid CLI
53
+ npx @solidxai/solidctl seed # seeds the database with SolidX metadata and system defaults
54
+ ```
55
+
56
+ ---
52
57
 
53
- # e2e tests
54
- $ npm run test:e2e
58
+ ## Commands
55
59
 
56
- # test coverage
57
- $ npm run test:cov
60
+ ### `create-app`
61
+
62
+ Scaffolds a new SolidX project. Runs an interactive setup wizard by default; all options can also be passed as flags for non-interactive use.
63
+
64
+ ```bash
65
+ npx @solidxai/solidctl create-app [options]
66
+ ```
67
+
68
+ | Flag | Default | Description |
69
+ |---|---|---|
70
+ | `--name <name>` | `my-solid-app` | Project directory name |
71
+ | `--api-port <port>` | `3000` | Port for the NestJS API |
72
+ | `--ui-port <port>` | `3001` | Port for the React frontend |
73
+ | `--db-client <client>` | `postgres` | Database client (`postgres`, `mysql`, etc.) |
74
+ | `--db-host <host>` | `localhost` | Database host |
75
+ | `--db-port <port>` | `5432` | Database port |
76
+ | `--db-name <name>` | `solidx_app_db` | Database name |
77
+ | `--db-username <user>` | `solidx_app_user` | Database username |
78
+ | `--db-password <pass>` | `strongpassword` | Database password |
79
+ | `--db-synchronize` | `false` | Enable TypeORM schema auto-sync |
80
+ | `--no-interactive` | — | Skip prompts and use flag values / defaults |
81
+
82
+ ---
83
+
84
+ ### `build`
85
+
86
+ Builds the NestJS API and sets up the local `solid` CLI shim so subsequent `solidctl` commands that proxy into the API (like `seed`, `generate`, and `test`) work correctly. Run this after project creation and after any changes to `solid-api`.
87
+
88
+ ```bash
89
+ npx @solidxai/solidctl build
58
90
  ```
59
91
 
60
- ## Deployment
92
+ This command:
93
+ 1. Runs `npm run build` inside `solid-api/`
94
+ 2. Creates a local `solid` CLI shim that points to the compiled output
95
+ 3. Verifies the shim is working correctly
96
+
97
+ > Must be run from the project root (the directory containing both `solid-api/` and `solid-ui/`).
98
+
99
+ ---
61
100
 
62
- When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
101
+ ### `seed`
63
102
 
64
- If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
103
+ Seeds the database with SolidX system metadata, permissions, default settings, and the initial admin user. Run once after the database is created and after any module metadata changes.
65
104
 
66
105
  ```bash
67
- $ npm install -g @nestjs/mau
68
- $ mau deploy
106
+ npx @solidxai/solidctl seed
69
107
  ```
70
108
 
71
- With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
109
+ Proxies to the `solid seed` command inside `solid-api/`. Any additional arguments are passed through.
72
110
 
73
- ## Resources
111
+ ---
112
+
113
+ ### `generate`
114
+
115
+ Regenerates NestJS boilerplate (entity, service, controller, repository, DTOs) for a model or an entire module based on the current metadata. Safe to run repeatedly — existing custom logic in generated files is preserved.
116
+
117
+ ```bash
118
+ # Regenerate a single model and its related models
119
+ npx @solidxai/solidctl generate model <model-name>
120
+
121
+ # Regenerate all models within a module
122
+ npx @solidxai/solidctl generate module <module-name>
123
+ ```
124
+
125
+ Under the hood, this proxies to `solid refresh-model` / `solid refresh-module`, which invokes `@solidxai/code-builder` to perform AST-level file updates.
126
+
127
+ ---
128
+
129
+ ### `upgrade`
130
+
131
+ Upgrades the core SolidX dependencies in both `solid-api` and `solid-ui` to the latest available version.
132
+
133
+ ```bash
134
+ # Upgrade to the latest beta pre-release (default)
135
+ npx @solidxai/solidctl upgrade
136
+
137
+ # Upgrade to the latest stable release
138
+ npx @solidxai/solidctl upgrade --stable
139
+
140
+ # Upgrade to a specific dist-tag
141
+ npx @solidxai/solidctl upgrade --tag next
142
+
143
+ # Preview what would change without installing
144
+ npx @solidxai/solidctl upgrade --dry-run
145
+ ```
146
+
147
+ Packages upgraded:
148
+ - `solid-api`: `@solidxai/core`, `@solidxai/code-builder`
149
+ - `solid-ui`: `@solidxai/core-ui`
150
+
151
+ ---
152
+
153
+ ### `test`
154
+
155
+ Runs the SolidX metadata-driven test suite defined in your module metadata. Proxies to `solid test` inside `solid-api/`.
156
+
157
+ ```bash
158
+ npx @solidxai/solidctl test [args]
159
+ ```
160
+
161
+ All arguments are passed through to the underlying `solid test` command. See the [testing framework documentation](https://docs.solidxai.com/docs) for details on writing test scenarios.
162
+
163
+ ---
164
+
165
+ ### `info`
166
+
167
+ Prints information about the current SolidX project — versions, configuration, and environment. Useful for debugging and support.
168
+
169
+ ```bash
170
+ npx @solidxai/solidctl info
171
+ ```
172
+
173
+ ---
174
+
175
+ ## Project structure
176
+
177
+ A project created by `solidctl create-app` follows this layout:
178
+
179
+ ```
180
+ my-solid-app/
181
+ ├── solid-api/ # NestJS backend
182
+ │ ├── src/
183
+ │ │ ├── app.module.ts # Root module importing SolidCoreModule
184
+ │ │ ├── main.ts # Application entry point
185
+ │ │ └── {your-modules}/ # Generated modules live here
186
+ │ ├── module-metadata/ # Metadata JSON files driving code generation
187
+ │ └── package.json
188
+ │
189
+ └── solid-ui/ # React frontend
190
+ ├── src/
191
+ │ ├── main.tsx # App entry point
192
+ │ └── App.tsx # Root component with SolidX providers
193
+ └── package.json
194
+ ```
74
195
 
75
- Check out a few resources that may come in handy when working with NestJS:
196
+ ---
76
197
 
77
- - Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
78
- - For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
79
- - To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
80
- - Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
81
- - Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
82
- - Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
83
- - To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
84
- - Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
198
+ ## Part of the SolidX Platform
85
199
 
86
- ## Support
200
+ `solidctl` is the developer interface to the full SolidX package ecosystem:
87
201
 
88
- Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
202
+ | Package | Role |
203
+ |---|---|
204
+ | [`@solidxai/core`](https://www.npmjs.com/package/@solidxai/core) | NestJS backend module — auth, CRUD, IAM, notifications, queues |
205
+ | [`@solidxai/core-ui`](https://www.npmjs.com/package/@solidxai/core-ui) | React admin panel — metadata-driven views, auth UI, Redux store |
206
+ | [`@solidxai/code-builder`](https://www.npmjs.com/package/@solidxai/code-builder) | Code generation engine — produces NestJS files from metadata |
207
+ | `@solidxai/solidctl` | This CLI — scaffolds, builds, generates, and upgrades |
89
208
 
90
- ## Stay in touch
209
+ | | |
210
+ |---|---|
211
+ | Website | [solidxai.com](https://solidxai.com) |
212
+ | Documentation | [docs.solidxai.com](https://docs.solidxai.com/docs) |
213
+ | Support | support@solidxai.com |
91
214
 
92
- - Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
93
- - Website - [https://nestjs.com](https://nestjs.com/)
94
- - Twitter - [@nestframework](https://twitter.com/nestframework)
215
+ ---
95
216
 
96
217
  ## License
97
218
 
98
- Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
219
+ BSL-1.1 © [Logicloop](https://logicloop.io)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@solidxai/solidctl",
3
- "version": "0.1.14-beta.0",
3
+ "version": "0.1.15",
4
4
  "description": "",
5
5
  "author": "",
6
6
  "private": false,