Vue Storefront is now Alokai! Learn More
@alokai/cli

@alokai/cli

1.0.1

Patch Changes

  • FIX Allow deployment of middleware without requiring frontend components

1.0.0

Major Changes

  • CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:

  • Upgraded to the latest version of Node.js 22
  • Updated CI pipelines to use Node.js 22 for consistency.
  • Updated .nvmrc or .node-version files to specify Node.js version 22.14.
  • Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.

Recommendations:

  • Use Node.js version 22.14.0 or higher for optimal performance, security, and compatibility.
  • While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested.

Minor Changes

  • ADDED Introduced additional options for the deployment command to enhance flexibility in deployment configurations.

Previously, the deployment command relied solely on the alokai.config.json file for configuration. With this update, you can now specify additional options directly via the command line. This provides greater control over the deployment process, making it easier to customize deployments for different environments or use cases.

New Options:

  • --framework: Define the framework to use for the deployment. This is particularly useful when working with multiple frameworks or switching between them frequently.
  • --project-name: Specify the project name for the deployment. This is helpful when deploying the same store to different environments, such as staging or production.
  • --cloud-region: Choose the cloud region for the deployment. This allows you to optimize deployments based on factors like latency, compliance, or geographic preferences.

Key Details:

  • Command-line options take precedence over the corresponding settings in the alokai.config.json file. This means you can maintain a default configuration in the file and override it as needed for specific deployments.
  • These options are applicable only for single-store deployments. They are not supported when using the --all flag for multi-store deployments.
  • ADDED Added a new flag --deployable for the changed command that will allow to find changes only for deployable stores
  • ADDED Enhanced the store deploy command with prerequisite checks to report missing dependencies early in the process.
  • ADDED Creating .env from .env.example (when overriden in a store) in all apps when composing a store.
  • ADDED Add alokai store remove command.
  • ADDED Added a way to pass playwright test options through the --playwright-options (-p) flag in the store test command.
alokai-cli store test --playwright-options="--project=nuxt-desktop --headed"
  • FIXED Fixed randomly failing integration tests when running them for multiple stores using the store test command. The issue was due to tests running in parallel through Turbo's pipeline. From now on, when running tests for multiple stores (using the --all flag or passing an array of store IDs via the --store-id flag), the tests will be run for each store consecutively.

Patch Changes

  • CHANGED Guarantee compatibility with @alokai/connect package.
  • FIXED .env composition. Now the store composition logic also checks for the ancestor .env files, before using the .env.example as a fallback.
  • FIXED Add missing defu dependency
  • FIXED Store composition now properly inherits .env.example files from parent stores, ensuring consistent environment configuration across the store hierarchy. If a store doesn't have its own .env.example, it will be copied from its parent stores or the base apps. Switch tag to RC
  • FIXED Added symlinks to node_modules for all apps inside stores directory. It helps avoiding type issues - previously the base app used non-hoisted node_modules for few packages, and stores always used hoisted-ones. Now as the node_modules are symlinked, there won't be such desynchronization.
  • FIXED Deployment of nested stores.
  • FIXED Disabled spinner in logs for start and build commands when run with the --verbose flag. Now a single log entry is displayed instead, ensuring logs are not obfuscated.
  • FIXED Respect start script when generating a start:standalone script
  • FIXED Running store test command with --ui flag.
  • FIXED store test now returns exit code 1 when it fails.
  • FIXED Add missing get-port-please dependency

1.0.0-rc.11

Patch Changes

Switch tag to RC

1.0.0-next.10

Minor Changes

  • ADDED Add alokai store remove command.

1.0.0-rc.9

Patch Changes

  • FIXED Respect start script when generating a start:standalone script
  • FIXED store test now returns exit code 1 when it fails.

1.0.0-rc.8

Patch Changes

  • FIXED .env composition. Now the store composition logic also checks for the ancestor .env files, before using the .env.example as a fallback.

1.0.0-rc.7

Patch Changes

  • FIXED Add missing get-port-please dependency

1.0.0-rc.6

Patch Changes

  • FIXED Add missing defu dependency

1.0.0-rc.5

Patch Changes

  • FIXED Store composition now properly inherits .env.example files from parent stores, ensuring consistent environment configuration across the store hierarchy. If a store doesn't have its own .env.example, it will be copied from its parent stores or the base apps.

1.0.0-rc.4

Minor Changes

  • ADDED Creating .env from .env.example (when overriden in a store) in all apps when composing a store.
  • ADDED Added a way to pass playwright test options through the --playwright-options (-p) flag in the store test command.
alokai-cli store test --playwright-options="--project=nuxt-desktop --headed"
  • FIXED Fixed randomly failing integration tests when running them for multiple stores using the store test command. The issue was due to tests running in parallel through Turbo's pipeline. From now on, when running tests for multiple stores (using the --all flag or passing an array of store IDs via the --store-id flag), the tests will be run for each store consecutively.

Patch Changes

  • FIXED Deployment of nested stores.
  • FIXED Running store test command with --ui flag.

1.0.0-rc.3

Minor Changes

  • ADDED Introduced additional options for the deployment command to enhance flexibility in deployment configurations.

Previously, the deployment command relied solely on the alokai.config.json file for configuration. With this update, you can now specify additional options directly via the command line. This provides greater control over the deployment process, making it easier to customize deployments for different environments or use cases.

New Options:

  • --framework: Define the framework to use for the deployment. This is particularly useful when working with multiple frameworks or switching between them frequently.
  • --project-name: Specify the project name for the deployment. This is helpful when deploying the same store to different environments, such as staging or production.
  • --cloud-region: Choose the cloud region for the deployment. This allows you to optimize deployments based on factors like latency, compliance, or geographic preferences.

Key Details:

  • Command-line options take precedence over the corresponding settings in the alokai.config.json file. This means you can maintain a default configuration in the file and override it as needed for specific deployments.
  • These options are applicable only for single-store deployments. They are not supported when using the --all flag for multi-store deployments.

1.0.0-rc.2

Major Changes

  • CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:

  • Upgraded to the latest version of Node.js 22
  • Updated CI pipelines to use Node.js 22 for consistency.
  • Updated .nvmrc or .node-version files to specify Node.js version 22.14.
  • Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.

Recommendations:

  • Use Node.js version 22.14.0 or higher for optimal performance, security, and compatibility.
  • While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested.

0.3.1

Patch Changes

  • FIXED Environment variable handling in Frontend app dev mode. URLs with suffixes (e.g., http://localhost:4000/api) for middleware API and SSR are now properly preserved.

0.3.0

Minor Changes

ADDED: CLI is now able to use different CONSOLE_API_URL based on the environment variable.

Patch Changes

CHANGED deploy command will print more debug info in case of an error

0.3.0-rc.1

Minor Changes

ADDED: CLI is now able to use different CONSOLE_API_URL based on the environment variable.

0.2.1-rc.0

Patch Changes

CHANGED deploy command will print more debug info in case of an error

0.2.0

Minor Changes

  • CHANGED output dir from dist to lib.
  • CHANGED Moved alokaiConfigSchema.json to the package. You should now change $schema value in alokai.config.json to node_modules/@alokai/cli/lib/static/alokaiConfigSchema.json and remove .alokai/alokaiConfigSchema.json from your repository.

Patch Changes

  • FIXED store changed command when repository contains just a single commit
  • FIXED Support cross env variables for Windows. Make sure to add cross-env library to your project, you can do it by
yarn add cross-env -W -D

0.2.0-rc.2

Minor Changes

  • CHANGED Moved alokaiConfigSchema.json to the package. You should now change $schema value in alokai.config.json to node_modules/@alokai/cli/lib/static/alokaiConfigSchema.json and remove .alokai/alokaiConfigSchema.json from your repository.

0.1.2-rc.1

Patch Changes

  • FIXED store changed command when repository contains just a single commit
  • FIXED Support cross env variables for Windows. Make sure to add cross-env library to your project, you can do it by
yarn add cross-env -W -D

0.1.2-rc.0

Patch Changes

  • FIXED store changed command when repository contains just a single commit
  • FIXED Support cross env variables for Windows. Make sure to add cross-env library to your project, you can do it by
yarn add cross-env -W -D

0.1.1

Patch Changes

  • FIXED Added missing ssr api url env to the composed package.json
  • FIXED build command returns now exit code 1 when build fails

0.1.0

Minor Changes

  • ADDED: Package created. Multistore functionality added.

Patch Changes

  • CHANGED deployment.frontend parameter to deployment.framework in alokai.config.json.
  • FIXED: Added missing lodash-es

0.1.0-rc.2

Patch Changes

  • CHANGED deployment.frontend parameter to deployment.framework in alokai.config.json.

0.1.0-rc.1

Patch Changes

  • FIXED: Added missing lodash-es

0.1.0-rc.0

Minor Changes

  • ADDED: Package created. Multistore functionality added.