66 lines
1.3 KiB
Plaintext
66 lines
1.3 KiB
Plaintext
---
|
|
sidebar_label: "exec"
|
|
sidebar_position: 7
|
|
---
|
|
|
|
import { Table } from "docs-ui"
|
|
|
|
export const metadata = {
|
|
title: `exec Command - Medusa CLI Reference`,
|
|
}
|
|
|
|
# {metadata.title}
|
|
|
|
Run a custom CLI script using Medusa's CLI tool. Learn more about it in [Custom CLI Scripts guide](!docs!/learn/fundamentals/custom-cli-scripts).
|
|
|
|
```bash
|
|
npx medusa exec [file] [args...]
|
|
```
|
|
|
|
## Arguments
|
|
|
|
<Table>
|
|
<Table.Header>
|
|
<Table.Row>
|
|
<Table.HeaderCell>Argument</Table.HeaderCell>
|
|
<Table.HeaderCell>Description</Table.HeaderCell>
|
|
<Table.HeaderCell>Required</Table.HeaderCell>
|
|
</Table.Row>
|
|
</Table.Header>
|
|
<Table.Body>
|
|
<Table.Row>
|
|
<Table.Cell>
|
|
|
|
`file`
|
|
|
|
</Table.Cell>
|
|
<Table.Cell>
|
|
|
|
The path to the TypeScript or JavaScript file containing the function to execute.
|
|
|
|
</Table.Cell>
|
|
<Table.Cell>
|
|
|
|
Yes
|
|
|
|
</Table.Cell>
|
|
</Table.Row>
|
|
<Table.Row>
|
|
<Table.Cell>
|
|
|
|
`args`
|
|
|
|
</Table.Cell>
|
|
<Table.Cell>
|
|
|
|
A list of arguments to pass to the function. These arguments are passed in the `args` property of the function's object parameter.
|
|
|
|
</Table.Cell>
|
|
<Table.Cell>
|
|
|
|
No
|
|
|
|
</Table.Cell>
|
|
</Table.Row>
|
|
</Table.Body>
|
|
</Table> |