@stacksjs/skills 0.70.113 → 0.70.114

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 +53 -66
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -34,7 +34,7 @@ As a developer, Stacks helps you every step along the way—in beginner & expert
34
34
 
35
35
  Stacks runs on [Bun](https://bun.sh). You'll need:
36
36
 
37
- - **Bun ≥ 1.3.11** — install with `curl -fsSL https://bun.sh/install | bash`, or upgrade an existing install with `bun upgrade`.
37
+ - **Bun ≥ 1.3.0** — install with `curl -fsSL https://bun.sh/install | bash`, or upgrade an existing install with `bun upgrade`.
38
38
  - **macOS, Linux, or WSL** — Windows-native is on the roadmap; today the toolchain assumes a POSIX shell.
39
39
  - **Node.js is NOT required.** Bun handles the JS/TS runtime, package management, and bundling.
40
40
 
@@ -45,7 +45,7 @@ That's it for the framework itself. Individual features (Postgres, Redis, AWS de
45
45
  The fastest path, assuming Bun is installed:
46
46
 
47
47
  ```bash
48
- bunx buddy new my-project
48
+ bunx @stacksjs/buddy new my-project
49
49
  ```
50
50
 
51
51
  A one-line installer (`curl -Ssf stacksjs.com/install | sh`) is also planned and will appear here once it lands; for now the `bunx` form above is the supported install path.
@@ -74,18 +74,16 @@ buddy --help # view help menu
74
74
  # please note: you may suffix any command with the
75
75
  # `command --help` flag to review the help menu
76
76
 
77
+ buddy new my-project # creates a new Stacks project
77
78
  buddy install # installs dependencies
78
79
  buddy add # adds a stack or dependency
79
- buddy fresh # fresh reinstall of all deps
80
- buddy clean # removes all deps
80
+ buddy fresh # fresh reinstall of all deps (--force skips the confirmation)
81
+ buddy clean # removes all deps (--force skips the confirmation)
81
82
  buddy setup # sets up the project initially
82
83
  buddy setup:oh-my-zsh # optional: sets up Oh My Zsh with auto-completions & "aliases"
83
84
 
84
- buddy upgrade # upgrades all dependencies
85
- buddy upgrade -i # prompts you to select which updates to apply (wip)
85
+ buddy upgrade # upgrades the Stacks framework (alias: buddy update)
86
86
  buddy upgrade:dependencies # auto-upgrades package.json deps
87
- buddy upgrade:framework # auto-upgrades deps & the Stacks framework
88
- buddy upgrade:search-engine # auto-upgrades configured search engine
89
87
  buddy upgrade:shell # upgrades the shell integration
90
88
  buddy upgrade:binary # upgrades the `stacks` binary
91
89
  buddy upgrade:bun # upgrades to latest project-defined Bun version
@@ -94,48 +92,42 @@ buddy upgrade:all # auto-upgrades all of the above
94
92
  # if you need any more info on any command listed here, you may suffix
95
93
  # any of them via the "help option", i.e. `buddy ... --help`
96
94
 
97
- buddy dev # starts the frontend dev server
98
- buddy dev -i # prompts any of the dev servers (components, functions, views, docs, or api)
95
+ buddy dev # starts the dev servers (frontend, api & docs)
96
+ buddy dev -i # prompts you to select which dev server to start
99
97
  buddy dev:api # starts the API dev server
100
98
  buddy dev:dashboard # starts the Admin/Dashboard dev server
101
99
  buddy dev:desktop # starts the Desktop dev server
102
100
  buddy dev:views # starts frontend dev server
103
101
  buddy dev:components # starts component dev server
104
- buddy dev:functions # stubs functions
105
102
  buddy dev:docs # starts local docs dev server
106
- buddy dev docs # also starts the local docs dev server (colon is optional for all commands)
107
- buddy development # `buddy dev` alias
103
+ buddy dev docs # also starts the local docs dev server (dev takes the server name as an argument)
108
104
 
109
105
  buddy share # creates a sharable link to your local project
110
106
 
111
- # for Laravel folks, `serve` may ring more familiar than the `dev` name. Hence, we aliased it
112
- buddy serve
113
- buddy serve:components
114
- buddy serve:desktop
115
- buddy serve:views
116
- buddy serve:functions
117
- buddy serve:docs
107
+ # production servers (the same entries the deploy target runs as services)
108
+ buddy serve # starts the production HTTP server (STX views + /api proxy)
109
+ buddy serve:api # starts the production API server
118
110
 
119
111
  # building for production (e.g. AWS, Google Cloud, npm, Vercel, Netlify, et al.)
120
112
  buddy build # select a specific build (follow CLI prompts)
121
- buddy build:views # builds SSG views
113
+ buddy build:frontend # builds the frontend (aliases: build:views, build:pages)
122
114
  buddy build:desktop # builds Desktop application
123
- buddy build:library # builds any or all libraries
124
115
  buddy build:functions # builds function library
125
116
  buddy build:components # builds Vue component library & Web Component library
126
117
  buddy build:web-components # builds framework agnostic Web Component library (i.e. Custom Elements)
127
- buddy build:all # builds all your code
128
-
129
- # `buddy build` aliases
130
- buddy prod
131
- buddy prod:components
132
- buddy prod:desktop
133
- buddy prod:library
134
- buddy prod:views
135
- buddy prod:functions
136
- buddy prod:web-components
137
- buddy prod:all
138
- buddy production # `buddy prod` alias
118
+ buddy build:cli # builds the Buddy CLI binary
119
+ buddy build:server # builds the Stacks cloud server (Docker image)
120
+ buddy build:docs # builds the documentation site
121
+
122
+ # `buddy build:*` aliases
123
+ buddy prod:components # alias for build:components
124
+ buddy prod:desktop # alias for build:desktop
125
+ buddy prod:web-components # alias for build:web-components
126
+ buddy prod:frontend # alias for build:frontend
127
+ buddy prod:cli # alias for build:cli
128
+ buddy prod:server # alias for build:server
129
+ buddy prod:docs # alias for build:docs
130
+ buddy prod:frontend-static # alias for build:frontend-static
139
131
 
140
132
  # sets your application key
141
133
  buddy key:generate
@@ -144,31 +136,28 @@ buddy make:component HelloWorld # bootstraps a HelloWorld component
144
136
  buddy make:function hello-world # bootstraps a hello-world function
145
137
  buddy make:view hello-world # bootstraps a hello-word page
146
138
  buddy make:model Car # bootstraps a Car model
147
- buddy make:database cars # creates a cars database
139
+ buddy make:database cars # prints guidance: tables come from models + migrations, there is no separate create step
148
140
  buddy make:migration create_cars_table # creates a cars migration file
149
141
  buddy make:factory cars # creates a Car factory file
150
- buddy make:table cars # bootstraps a cars data table
151
142
  buddy make:notification welcome-email # bootstraps a welcome-email notification
152
143
  buddy make:lang de # bootstraps a lang/de.yml language file
153
- buddy make:stack my-project # shares logic with `bunx --bun stacks new my-project`
144
+ buddy make:stack my-plugin # scaffolds a publishable stack/plugin (new project? use `bunx @stacksjs/buddy new`)
154
145
 
155
146
  buddy migrate # runs database migrations
147
+ buddy migrate:fresh # drops all tables & re-runs migrations (destroys all data; --seed reseeds)
156
148
  buddy migrate:dns # sets the ./config/dns.ts file
149
+ buddy seed # runs database seeders
157
150
 
158
151
  buddy dns example.com # list all DNS records for example.com
159
152
  buddy dns example.com --type MX # list MX records for example.com
160
153
 
161
- buddy https example.com/api/hello
162
- # http [flags] [METHOD] URL [ITEM [ITEM]]
163
- buddy http --help
164
- buddy http PUT example.com/api/put X-API-Token:123 name=John # Custom HTTP method, HTTP headers and JSON data
165
- buddy http -v example.com/api/get # See the request that is being sent using one of the output options
166
- buddy http POST example.com/api/post hello=World # submitting forms
167
- buddy http -a USERNAME POST https://api.github.com/repos/user/repo/issues/83/comments body='Great feature! :heart:'
168
- buddy http localhost:8000 Host:example.com
154
+ buddy http example.com/api/hello # sends a GET request & prints the response
155
+ buddy http -v example.com/api/get # same, with verbose output
169
156
 
170
157
  buddy lint # runs linter
171
158
  buddy lint:fix # runs linter and fixes issues
159
+ buddy format # formats your project codebase
160
+ buddy format:check # checks formatting without making changes
172
161
 
173
162
  buddy commit # follow CLI prompts for committing staged changes
174
163
  buddy release # creates the releases for the stack & triggers the Release Action (workflow)
@@ -176,21 +165,12 @@ buddy changelog # generates CHANGELOG.md
176
165
 
177
166
  # when deploying your app/s to a remote server or cloud provider
178
167
  buddy deploy # select a specific deployment (follow CLI prompts)
179
- # buddy deploy:docs # deploys docs to AWS (or other configured provider)
180
- # buddy deploy:functions # deploys functions to AWS (or other configured provider)
181
- # buddy deploy:views # deploys views to AWS (or other configured provider)
182
- # buddy deploy:all # deploys all your code
183
- buddy undeploy # be careful: "undeploys" removes/deletes your deployed resources
168
+ buddy undeploy # be careful: "undeploys" removes/deletes your deployed resources (--yes skips the confirmation)
184
169
 
185
170
  buddy cloud:remove # removes cloud setup
186
171
  buddy cloud:cleanup # removes cloud setup & cleans up all potentially leftover resources
187
172
  buddy cloud:add --jump-box # adds a jump box to your cloud setup
188
173
 
189
- # select the example to run (follow CLI prompts)
190
- buddy example # prompts you to select which example to run
191
- buddy example:vue # runs the Vue example
192
- buddy example:web-components # runs the Web Component example
193
-
194
174
  # you likely won’t need to run these commands as they are auto-triggered, but they are available
195
175
  buddy generate # prompts you to select which generator to run
196
176
  buddy generate:types # generates types for your components, functions, & views
@@ -199,7 +179,6 @@ buddy generate:web-types # generates Web Component types
199
179
  buddy generate:vscode-custom-data # generates VSCode custom data
200
180
  buddy generate:ide-helpers # generates IDE helpers
201
181
  buddy generate:component-meta # generates component meta
202
- buddy generate:all # runs all generators
203
182
 
204
183
  # generates your application key
205
184
  buddy key:generate # generates your application key
@@ -216,23 +195,31 @@ buddy env:rotate # rotate a keypair
216
195
  buddy types:generate # generates types for your components, functions, & views
217
196
  buddy types:fix # auto-fixes types for your components, functions, & views
218
197
 
219
- buddy domains # alias for `buddy domains:list`
220
198
  buddy domains:add stacksjs.com # adds a domain
221
199
  buddy domains:remove stacksjs.com # removes a domain
222
- buddy domains:list # lists all domains
223
- buddy domains:update # apply ./config/dns.ts updates
224
200
  buddy domains:purchase stacksjs.com # purchase a new domain
225
201
 
202
+ # handy utilities
203
+ buddy doctor # runs health checks on your Stacks installation
204
+ buddy list # lists all available Buddy commands
205
+ buddy route:list # lists your routes
206
+ buddy ports # checks your project for port issues & misconfigurations
207
+ buddy outdated # lists outdated project dependencies
208
+ buddy env:check # checks your environment configuration & validates setup
209
+ buddy tinker # interactive REPL with the Stacks framework preloaded
210
+ buddy down # puts the app into maintenance mode
211
+ buddy up # brings the app out of maintenance mode
212
+
226
213
  # test your stack
227
- buddy test # runs test suite (unit & e2e)
228
- buddy test:coverage # runs test coverage
214
+ buddy test # runs your test suite
215
+ buddy test:unit # runs unit tests
216
+ buddy test:feature # runs feature tests
229
217
  buddy test:types # runs typecheck
230
218
 
231
- # the CLI may be triggered in any
232
- # of the following syntax
233
- stx fresh
234
- buddy fresh
235
- bud fresh
219
+ # the published @stacksjs/buddy package ships
220
+ # `buddy`, `bud`, & `stx` bins; inside this repo
221
+ # the CLI is invoked as ./buddy
222
+ ./buddy fresh
236
223
  ```
237
224
 
238
225
  </details>
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@stacksjs/skills",
3
3
  "type": "module",
4
4
  "sideEffects": false,
5
- "version": "0.70.113",
5
+ "version": "0.70.114",
6
6
  "description": "Agent skills for the Stacks framework, following the agentskills.io standard.",
7
7
  "author": "Chris Breuer",
8
8
  "contributors": [
@@ -54,11 +54,11 @@
54
54
  "prepublishOnly": "bun run build"
55
55
  },
56
56
  "dependencies": {
57
- "@stacksjs/path": "0.70.113",
58
- "@stacksjs/storage": "0.70.113"
57
+ "@stacksjs/path": "0.70.114",
58
+ "@stacksjs/storage": "0.70.114"
59
59
  },
60
60
  "devDependencies": {
61
- "better-dx": "^0.2.16",
62
- "@stacksjs/types": "0.70.113"
61
+ "better-dx": "catalog:",
62
+ "@stacksjs/types": "0.70.114"
63
63
  }
64
64
  }