Skip to content

Commit f20b14a

Browse files
committed
feat: add list command
1 parent 1916f9f commit f20b14a

File tree

7 files changed

+29
-25
lines changed

7 files changed

+29
-25
lines changed

Diff for: docs/content/guides/7.multistore/2.tooling-and-concepts/1.index.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,13 @@ Alokai supports two types of stores to accommodate different business needs:
9494
To create a new store, use the `store add` command:
9595

9696
```bash
97-
yarn store add
97+
yarn alokai store add
9898
```
9999

100+
:::tip
101+
run `yarn alokai list` to see all availble commands
102+
:::
103+
100104
The CLI will guide you through configuring your store, including:
101105
- Setting a unique store ID
102106
- Choosing a parent store (or inheriting from base apps)

Diff for: docs/content/guides/7.multistore/2.tooling-and-concepts/2.development/3.managing-the-stores.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Let's explore how to manage your stores effectively.
2727
The `store add` command guides you through creating a new store and sets up all necessary configurations:
2828

2929
```bash
30-
yarn store add
30+
yarn alokai store add
3131
```
3232

3333
### Store Creation Flow
@@ -161,7 +161,7 @@ apps/stores/my-brand-us/
161161
The `store move` command helps reorganize your store hierarchy:
162162

163163
```bash
164-
yarn store move
164+
yarn alokai store move
165165
```
166166

167167
### Move Process

Diff for: docs/content/guides/7.multistore/2.tooling-and-concepts/2.development/4.local-environment.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The most common way to start development is using the yarn scripts from the root
3434
yarn dev
3535

3636
# Start development for a specific store
37-
yarn store dev --store-id=my-store
37+
yarn alokai store dev --store-id=my-store
3838
# Alternatively, you may use: ./node_modules/.bin/alokai-cli store dev --store-id=my-store
3939
```
4040

@@ -82,7 +82,7 @@ Alokai uses Caddy as a reverse proxy to handle local domains. The Caddyfile is a
8282
Start all stores with their local domains:
8383

8484
```bash
85-
yarn store dev --all --with-local-domains
85+
yarn alokai store dev --all --with-local-domains
8686
```
8787

8888
:::tip HTTPS
@@ -117,7 +117,7 @@ yarn test:integration:pw
117117
You can also run tests in Playwright's UI mode for better debugging experience:
118118

119119
```bash
120-
yarn store test --store-id=my-store --ui
120+
yarn alokai store test --store-id=my-store --ui
121121
```
122122

123123
:::warning
@@ -156,17 +156,17 @@ The `.out` directory contains the composed stores and is in `.gitignore`. If you
156156
1. **Use Store-Specific Development**
157157
When working on a single store, use the `--store-id` flag to improve build times:
158158
```bash
159-
yarn store dev --store-id=my-store
159+
yarn alokai store dev --store-id=my-store
160160
```
161161

162162
2. **Test Inheritance Chain**
163163
When modifying shared code, test all affected stores:
164164
```bash
165165
# See which stores are affected by current changes
166-
yarn store changed
166+
yarn alokai store changed
167167

168168
# Build and test affected stores
169-
yarn store build --store-id=affected-store-id-1,affected-store-id-2
169+
yarn alokai store build --store-id=affected-store-id-1,affected-store-id-2
170170
```
171171

172172
:::tip
@@ -176,17 +176,17 @@ In the Continuous Integration and Continuous Deployment pipelines, the affected
176176
1. **Debugging Inheritance**
177177
Use the `--verbose` flag to see detailed file resolution:
178178
```bash
179-
yarn store build --store-id=my-store --verbose
179+
yarn alokai store build --store-id=my-store --verbose
180180
```
181181
You can also use the `DEBUG=*` environment variable to get even more logs:
182182
```bash
183-
DEBUG=* yarn store build --store-id=my-store
183+
DEBUG=* yarn alokai store build --store-id=my-store
184184
```
185185

186186
1. **Inspect Store Composition**
187187
Examine how stores are composed in the `.out` directory:
188188
```bash
189-
yarn store build --store-id=my-store --compose-only
189+
yarn alokai store build --store-id=my-store --compose-only
190190
```
191191
This will skip the build and only compose the store into the `.out` directory.
192192

Diff for: docs/content/guides/7.multistore/2.tooling-and-concepts/2.development/5.integration-tests.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -242,13 +242,13 @@ You can run tests in two modes:
242242
#### Standard Mode
243243
```bash
244244
# Run all tests for a specific store
245-
yarn store test --store-id=fashion-brand
245+
yarn alokai store test --store-id=fashion-brand
246246
```
247247

248248
#### UI Mode (for debugging)
249249
```bash
250250
# Open Playwright UI for interactive debugging
251-
yarn store test --store-id=fashion-brand --ui
251+
yarn alokai store test --store-id=fashion-brand --ui
252252
```
253253

254254
::tip

Diff for: docs/content/guides/7.multistore/2.tooling-and-concepts/3.deployment/6.deployment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Ever wondered how Alokai transforms your codebase into a live, running applicati
1313
Ready to deploy your store? It all starts with a single command:
1414

1515
```bash
16-
yarn store deploy
16+
yarn alokai store deploy
1717
```
1818

1919
While this command is typically executed in your [continuous delivery pipeline](/guides/multistore/tooling-and-concepts/deployment/ci-cd), you can also run the deployment locally on your machine.

Diff for: docs/content/guides/7.multistore/2.tooling-and-concepts/3.deployment/7.configuration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Triggering deployments locally should only be used for development and testing p
182182
One of the great things about Alokai is how simple it makes deployments! The basic deployment command is:
183183

184184
```bash
185-
yarn store deploy --store-id=fashion-brand \
185+
yarn alokai store deploy --store-id=fashion-brand \
186186
--cloud-username=your_username \
187187
--cloud-password=your_password
188188
```
@@ -204,14 +204,14 @@ export CLI_CLOUD_PASSWORD=your_password
204204

205205
With either approach, you'll only need to specify the store-id:
206206
```bash
207-
yarn store deploy --store-id=fashion-brand
207+
yarn alokai store deploy --store-id=fashion-brand
208208
```
209209
::
210210

211211
That's it! The CLI handles all the complexity of building, packaging, and deploying your store. You can also add `--verbose` flag to see detailed logs:
212212

213213
```bash
214-
yarn store deploy --store-id=fashion-brand \
214+
yarn alokai store deploy --store-id=fashion-brand \
215215
--verbose # Optional: see detailed deployment logs
216216
```
217217

Diff for: docs/content/guides/7.multistore/2.tooling-and-concepts/3.deployment/8.cd.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ The `store deploy` command handles both building and deploying your stores. Ther
7474
steps:
7575
- name: Deploy stores
7676
run: |
77-
yarn store deploy \
77+
yarn alokai store deploy \
7878
--cloud-username ${{ vars.CLOUD_USERNAME }} \
7979
--cloud-password ${{ secrets.CLOUD_PASSWORD }} \
8080
$storeIdsFlag \
@@ -94,7 +94,7 @@ jobs:
9494
steps:
9595
- name: Deploy store
9696
run: |
97-
yarn store deploy \
97+
yarn alokai store deploy \
9898
--cloud-username ${{ vars.CLOUD_USERNAME }} \
9999
--cloud-password ${{ secrets.CLOUD_PASSWORD }} \
100100
--store-id ${{ matrix.store_id }} \
@@ -105,7 +105,7 @@ jobs:
105105

106106
### Understanding Change Detection
107107

108-
The change detection system is a core part of our CI/CD pipeline, implemented in the CLI, with `yarn store changed` command, to ensure consistent behavior across different CI platforms. Here's how it works:
108+
The change detection system is a core part of our CI/CD pipeline, implemented in the CLI, with `yarn alokai store changed` command, to ensure consistent behavior across different CI platforms. Here's how it works:
109109

110110
The change detection system analyzes git differences and determines which stores are affected based on several rules:
111111

@@ -138,10 +138,10 @@ The change detection system analyzes git differences and determines which stores
138138
- Affected: All stores
139139

140140
5. **Global Dependencies**
141-
Changes to globally configured paths (e.g., shared packages) affect all stores. You can mark global dependencies for the `yarn store changed` command by adding the `--global-dependencies` flag. For example:
141+
Changes to globally configured paths (e.g., shared packages) affect all stores. You can mark global dependencies for the `yarn alokai store changed` command by adding the `--global-dependencies` flag. For example:
142142
```bash
143143
# Mark all packages in the packages directory as global dependencies
144-
yarn store changed --global-dependencies="packages/**"
144+
yarn alokai store changed --global-dependencies="packages/**"
145145
```
146146

147147
6. **File Overrides**
@@ -159,7 +159,7 @@ The system provides detailed information about why each store was affected:
159159
- `GLOBAL_DEPENDENCIES_CHANGED`: Changes in globally configured paths
160160

161161
::tip
162-
When debugging why a particular store was affected, run the `yarn store changed` command without the `--condensed` flag to see the detailed change report. You can also run the command locally to debug the changes.
162+
When debugging why a particular store was affected, run the `yarn alokai store changed` command without the `--condensed` flag to see the detailed change report. You can also run the command locally to debug the changes.
163163
::
164164

165165
::info Why not use Turbo for change detection?
@@ -218,7 +218,7 @@ We use a single CLI command:
218218
```yaml
219219
# Do this instead
220220
- name: Detect changes
221-
run: yarn store changed --since $SINCE_SHA --to $TO_SHA
221+
run: yarn alokai store changed --since $SINCE_SHA --to $TO_SHA
222222
```
223223

224224
This approach makes it easy to implement our CI/CD pipeline in any CI system that can run shell commands.

0 commit comments

Comments
 (0)