964927b597
* docs improvements and changes * updated module definition * modules + dml changes * fix build * fix vale error * fix lint errors * fixes to stripe docs * fix condition * fix condition * fix module defintion * fix checkout * disable UI action * change oas preview action * flatten provider module options * fix lint errors * add module link docs * pr comments fixes * fix vale error * change node engine version * links -> linkable * add note about database name * small fixes * link fixes * fix response code in api reference * added migrations step
73 lines
1.9 KiB
Plaintext
73 lines
1.9 KiB
Plaintext
export const metadata = {
|
|
title: `${pageNumber} Custom CLI Scripts`,
|
|
}
|
|
|
|
# {metadata.title}
|
|
|
|
In this chapter, you'll learn how create and execute custom scripts from Medusa's CLI tool.
|
|
|
|
## What is a Custom CLI Script?
|
|
|
|
A custom CLI script is a function to execute through Medusa's CLI tool. This is useful when creating custom Medusa tooling to run through the CLI.
|
|
|
|
---
|
|
|
|
## How to Create a Custom CLI Script?
|
|
|
|
To create a custom CLI script, create a TypeScript or JavaScript file under the `src/scripts` directory. The file must default export a function.
|
|
|
|
For example, create the file `src/scripts/my-script.ts` with the following content:
|
|
|
|
```ts title="src/scripts/my-script.ts"
|
|
import {
|
|
ExecArgs,
|
|
IProductModuleService,
|
|
} from "@medusajs/types"
|
|
import { ModuleRegistrationName } from "@medusajs/utils"
|
|
|
|
export default async function myScript({ container }: ExecArgs) {
|
|
const productModuleService: IProductModuleService = container.resolve(
|
|
ModuleRegistrationName.PRODUCT
|
|
)
|
|
|
|
const [, count] = await productModuleService
|
|
.listAndCountProducts()
|
|
|
|
console.log(`You have ${count} product(s)`)
|
|
}
|
|
```
|
|
|
|
The function receives as a parameter an object having a `container` property, which is an instance of the Medusa Container. Use it to resolve resources in your Medusa application.
|
|
|
|
---
|
|
|
|
## How to Run Custom CLI Script?
|
|
|
|
To run the custom CLI script, run the Medusa CLI's `exec` command:
|
|
|
|
```bash
|
|
npx medusa exec ./src/scripts/my-script.ts
|
|
```
|
|
|
|
---
|
|
|
|
## Custom CLI Script Arguments
|
|
|
|
Your script can accept arguments from the command line. Arguments are passed to the function's object parameter in the `args` property.
|
|
|
|
For example:
|
|
|
|
```ts
|
|
import { ExecArgs } from "@medusajs/types"
|
|
|
|
export default async function myScript({ args }: ExecArgs) {
|
|
console.log(`The arguments you passed: ${args}`)
|
|
}
|
|
```
|
|
|
|
Then, pass the arguments in the `exec` command after the file path:
|
|
|
|
```bash
|
|
npx medusa exec ./src/scripts/my-script.ts arg1 arg2
|
|
```
|