> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/pdia-data-integration/10.2-data-integration/advanced-topics-pentaho-data-integration-overview/use-command-line-tools-to-run-transformations-and-jobs/pan-options-and-syntax.md).

# Pan Options and Syntax

Pan runs transformations, either from a PDI repository (database or enterprise) or a local file. The syntax for the shell script and batch file are shown below. All Pan options are the same for both.

**Note:** Windows systems use syntax with the forward slash (“`/`”) and colon (“`:`”). If spaces are present in the option values, use single quotes (`“`) and double quotes (`“”`) to keep spaces together, for example, `"-param:MASTER_HOST=192.168.1.3" "-param:MASTER_PORT=8181"`

```
pan.sh -option=value arg1 arg2
```

```
pan.bat /option: value arg1 arg2
```

For example:

```
sh pan.sh -rep=initech_pdi_repo -user=pgibbons -pass=lumburgh -trans=TPS_reports_2011
```

```
pan.bat /rep:initech_pdi_repo /user:pgibbons /pass:lumburgh /trans:TPS_reports_2011
```

| Switch        | Purpose                                                                                                                                                                                                                                                                                                |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| rep           | Enterprise repository name.                                                                                                                                                                                                                                                                            |
| user          | Repository username.                                                                                                                                                                                                                                                                                   |
| pass          | Repository password.                                                                                                                                                                                                                                                                                   |
| trans         | The name of the transformation you want to launch.                                                                                                                                                                                                                                                     |
| dir           | The repository directory that contains the transformation, including the leading slash.                                                                                                                                                                                                                |
| file          | If you are calling a local KTR file, this is the filename, including the path if it is not located in the local directory.                                                                                                                                                                             |
| level         | Set the logging level: Basic, Detailed, Debug, Rowlevel, Error, Nothing.                                                                                                                                                                                                                               |
| logfile       | The logging file path to write to.                                                                                                                                                                                                                                                                     |
| listdir       | List the directories in the specified repository.                                                                                                                                                                                                                                                      |
| listtrans     | List the transformations in the specified repository directory.                                                                                                                                                                                                                                        |
| listrep       | List the available repositories.                                                                                                                                                                                                                                                                       |
| exprep        | Export all repository objects to one XML file.                                                                                                                                                                                                                                                         |
| norep         | Prevent Pan from logging into a repository. If you have set the KETTLE\_REPOSITORY, KETTLE\_USER, and KETTLE\_PASSWORD environment variables, then this option will enable you to prevent Pan from logging into the specified repository, assuming you would like to execute a local KTR file instead. |
| safemode      | Run in safe mode, which enables extra checking.                                                                                                                                                                                                                                                        |
| version       | Show the version, revision, and build date.                                                                                                                                                                                                                                                            |
| param         | Set a named parameter in a *name=value* format. For example: *-param:Foo=bar*                                                                                                                                                                                                                          |
| listparam     | List information about the defined named parameters in the specified transformation.                                                                                                                                                                                                                   |
| metrics       | Gather metrics during execution.                                                                                                                                                                                                                                                                       |
| maxloglines   | Set the maximum number of log lines that are kept internally by PDI. Set to 0 to keep all rows (default).                                                                                                                                                                                              |
| maxlogtimeout | Set the maximum age (in minutes) of a log line while being kept internally by PDI. Set to 0 to keep all rows indefinitely (default).                                                                                                                                                                   |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pentaho.com/pdia-data-integration/10.2-data-integration/advanced-topics-pentaho-data-integration-overview/use-command-line-tools-to-run-transformations-and-jobs/pan-options-and-syntax.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
