@c9up/ream-cli-linux-arm64 0.3.6
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 +96 -0
- package/package.json +7 -0
- package/ream +0 -0
package/README.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# ream
|
|
2
|
+
|
|
3
|
+
Rust-native CLI for the Ream framework. Instant startup, no Node.js boot penalty.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @c9up/ream-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Commands
|
|
12
|
+
|
|
13
|
+
Run `ream --help` (or `ream <command> --help`) for the authoritative,
|
|
14
|
+
always up-to-date list. What the binary itself defines:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
# Scaffolding
|
|
18
|
+
ream new my-app # create a new Ream project
|
|
19
|
+
ream template kitchen-sink # install a project template from its upstream repo
|
|
20
|
+
|
|
21
|
+
# Development
|
|
22
|
+
ream dev # dev server + whatever builds the assets, under one Ctrl-C
|
|
23
|
+
ream build # assets, then TypeScript into dist/
|
|
24
|
+
ream start # run production (spawns node)
|
|
25
|
+
ream test # the suites declared in reamrc.ts
|
|
26
|
+
ream repl # a Node REPL with the application booted
|
|
27
|
+
|
|
28
|
+
# Code generation
|
|
29
|
+
ream make:controller order Order # app/order/OrderController.ts
|
|
30
|
+
ream make:service order Payment # app/order/PaymentService.ts
|
|
31
|
+
ream make:entity order OrderItem # app/order/OrderItem.ts
|
|
32
|
+
ream make:validator order CreateOrder
|
|
33
|
+
ream make:module order Order # entity + controller + validator + migration
|
|
34
|
+
ream make:provider Stripe
|
|
35
|
+
ream make:command app:provision # commands/app-provision.ts, discovered automatically
|
|
36
|
+
ream make:middleware auth --stack router
|
|
37
|
+
ream make:event orderShipped
|
|
38
|
+
ream make:listener sendMail --event orderShipped
|
|
39
|
+
ream stubs:publish controller # copy a make: template into stubs/make/ to edit it
|
|
40
|
+
|
|
41
|
+
# Packages
|
|
42
|
+
ream add @c9up/atlas # install a package AND run its configure() hook
|
|
43
|
+
ream configure @c9up/photon # (re-)run a package's configure() hook
|
|
44
|
+
|
|
45
|
+
# Integrations / tooling
|
|
46
|
+
ream mcp install # manage the Ream MCP server registration (.mcp.json)
|
|
47
|
+
ream generate:key # a fresh APP_KEY into .env
|
|
48
|
+
ream inspect # routes, providers, container bindings
|
|
49
|
+
ream list # every command — this binary's and the app's
|
|
50
|
+
|
|
51
|
+
# Diagnostics
|
|
52
|
+
ream doctor # environment health checks
|
|
53
|
+
ream info # version info
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Every `make:` command takes `--dry-run` (print the plan as JSON, write nothing)
|
|
57
|
+
and `--force` (overwrite what is there).
|
|
58
|
+
|
|
59
|
+
Anything else is dispatched to the application's console kernel with its flags
|
|
60
|
+
intact, so a package's commands and the app's own run the same way:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
ream migrate # @c9up/ream, across every registered store
|
|
64
|
+
ream migration:run # @c9up/atlas
|
|
65
|
+
ream make:migration create_orders_table
|
|
66
|
+
ream schedule:list
|
|
67
|
+
ream provision --email you@example.com # the app's own
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Build from source
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
cargo build --release
|
|
74
|
+
# Binary at target/release/ream
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Assets
|
|
78
|
+
|
|
79
|
+
`ream dev` runs the server and whatever builds your assets as one thing, and `ream build` builds the assets before TypeScript. Declare them in `reamrc.ts`:
|
|
80
|
+
|
|
81
|
+
```ts
|
|
82
|
+
export default {
|
|
83
|
+
assets: {
|
|
84
|
+
devServer: { command: 'pnpm', args: ['css:watch'] },
|
|
85
|
+
build: { command: 'pnpm', args: ['css'] },
|
|
86
|
+
},
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Output is line-prefixed per process, and when one stops the other is stopped with it — a Ctrl-C leaves no orphan watcher holding the output file. Without this, an app ends up wiring `concurrently -k` itself.
|
|
91
|
+
|
|
92
|
+
Both keys are optional: with no `assets`, `ream dev` and `ream build` behave exactly as before.
|
|
93
|
+
|
|
94
|
+
## License
|
|
95
|
+
|
|
96
|
+
MIT
|
package/package.json
ADDED
package/ream
ADDED
|
Binary file
|