# {py:mod}`arelle.CntlrCmdLine`

```{py:module} arelle.CntlrCmdLine
```

```{autodoc2-docstring} arelle.CntlrCmdLine
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ParserForDynamicPlugins <arelle.CntlrCmdLine.ParserForDynamicPlugins>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.ParserForDynamicPlugins
    :summary:
    ```
* - {py:obj}`CntlrCmdLine <arelle.CntlrCmdLine.CntlrCmdLine>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.CntlrCmdLine
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`main <arelle.CntlrCmdLine.main>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.main
    :summary:
    ```
* - {py:obj}`wsgiApplication <arelle.CntlrCmdLine.wsgiApplication>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.wsgiApplication
    :summary:
    ```
* - {py:obj}`_parseAndRun <arelle.CntlrCmdLine._parseAndRun>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine._parseAndRun
    :summary:
    ```
* - {py:obj}`parseAndRun <arelle.CntlrCmdLine.parseAndRun>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.parseAndRun
    :summary:
    ```
* - {py:obj}`preparseArgs <arelle.CntlrCmdLine.preparseArgs>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.preparseArgs
    :summary:
    ```
* - {py:obj}`parseArgs <arelle.CntlrCmdLine.parseArgs>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.parseArgs
    :summary:
    ```
* - {py:obj}`createCntlrAndPreloadPlugins <arelle.CntlrCmdLine.createCntlrAndPreloadPlugins>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.createCntlrAndPreloadPlugins
    :summary:
    ```
* - {py:obj}`_configAndRunCntlr <arelle.CntlrCmdLine._configAndRunCntlr>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine._configAndRunCntlr
    :summary:
    ```
* - {py:obj}`configAndRunCntlr <arelle.CntlrCmdLine.configAndRunCntlr>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.configAndRunCntlr
    :summary:
    ```
* - {py:obj}`_pluginHasCliOptions <arelle.CntlrCmdLine._pluginHasCliOptions>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine._pluginHasCliOptions
    :summary:
    ```
* - {py:obj}`_parseOptionsFile <arelle.CntlrCmdLine._parseOptionsFile>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine._parseOptionsFile
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`STILL_ACTIVE <arelle.CntlrCmdLine.STILL_ACTIVE>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.STILL_ACTIVE
    :summary:
    ```
* - {py:obj}`PROCESS_QUERY_INFORMATION <arelle.CntlrCmdLine.PROCESS_QUERY_INFORMATION>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.PROCESS_QUERY_INFORMATION
    :summary:
    ```
* - {py:obj}`DISABLE_PERSISTENT_CONFIG_OPTION <arelle.CntlrCmdLine.DISABLE_PERSISTENT_CONFIG_OPTION>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.DISABLE_PERSISTENT_CONFIG_OPTION
    :summary:
    ```
* - {py:obj}`TESTCASE_EXPECTED_ERRORS_OPTION <arelle.CntlrCmdLine.TESTCASE_EXPECTED_ERRORS_OPTION>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.TESTCASE_EXPECTED_ERRORS_OPTION
    :summary:
    ```
* - {py:obj}`UILANG_OPTION <arelle.CntlrCmdLine.UILANG_OPTION>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.UILANG_OPTION
    :summary:
    ```
* - {py:obj}`_ <arelle.CntlrCmdLine._>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine._
    :summary:
    ```
* - {py:obj}`PREPARSE_ARG_CONFIGS <arelle.CntlrCmdLine.PREPARSE_ARG_CONFIGS>`
  - ```{autodoc2-docstring} arelle.CntlrCmdLine.PREPARSE_ARG_CONFIGS
    :summary:
    ```
````

### API

````{py:data} STILL_ACTIVE
:canonical: arelle.CntlrCmdLine.STILL_ACTIVE
:value: >
   259

```{autodoc2-docstring} arelle.CntlrCmdLine.STILL_ACTIVE
```

````

````{py:data} PROCESS_QUERY_INFORMATION
:canonical: arelle.CntlrCmdLine.PROCESS_QUERY_INFORMATION
:value: >
   1024

```{autodoc2-docstring} arelle.CntlrCmdLine.PROCESS_QUERY_INFORMATION
```

````

````{py:data} DISABLE_PERSISTENT_CONFIG_OPTION
:canonical: arelle.CntlrCmdLine.DISABLE_PERSISTENT_CONFIG_OPTION
:value: >
   '--disablePersistentConfig'

```{autodoc2-docstring} arelle.CntlrCmdLine.DISABLE_PERSISTENT_CONFIG_OPTION
```

````

````{py:data} TESTCASE_EXPECTED_ERRORS_OPTION
:canonical: arelle.CntlrCmdLine.TESTCASE_EXPECTED_ERRORS_OPTION
:value: >
   'testcaseExpectedErrors'

```{autodoc2-docstring} arelle.CntlrCmdLine.TESTCASE_EXPECTED_ERRORS_OPTION
```

````

````{py:data} UILANG_OPTION
:canonical: arelle.CntlrCmdLine.UILANG_OPTION
:value: >
   '--uiLang'

```{autodoc2-docstring} arelle.CntlrCmdLine.UILANG_OPTION
```

````

````{py:data} _
:canonical: arelle.CntlrCmdLine._
:type: arelle.typing.TypeGetText
:value: >
   None

```{autodoc2-docstring} arelle.CntlrCmdLine._
```

````

````{py:function} main() -> None
:canonical: arelle.CntlrCmdLine.main

```{autodoc2-docstring} arelle.CntlrCmdLine.main
```
````

````{py:function} wsgiApplication(extraArgs: list[str] | None = None) -> CntlrCmdLine
:canonical: arelle.CntlrCmdLine.wsgiApplication

```{autodoc2-docstring} arelle.CntlrCmdLine.wsgiApplication
```
````

````{py:function} _parseAndRun(args: list[str]) -> tuple[bottle.Bottle | CntlrCmdLine | None, arelle.RuntimeOptions.RuntimeOptions, bool | None]
:canonical: arelle.CntlrCmdLine._parseAndRun

```{autodoc2-docstring} arelle.CntlrCmdLine._parseAndRun
```
````

````{py:function} parseAndRun(args: list[str]) -> CntlrCmdLine
:canonical: arelle.CntlrCmdLine.parseAndRun

```{autodoc2-docstring} arelle.CntlrCmdLine.parseAndRun
```
````

````{py:data} PREPARSE_ARG_CONFIGS
:canonical: arelle.CntlrCmdLine.PREPARSE_ARG_CONFIGS
:value: >
   'frozenset(...)'

```{autodoc2-docstring} arelle.CntlrCmdLine.PREPARSE_ARG_CONFIGS
```

````

````{py:function} preparseArgs(args: list[str], parser: optparse.OptionParser) -> dict[str, str]
:canonical: arelle.CntlrCmdLine.preparseArgs

```{autodoc2-docstring} arelle.CntlrCmdLine.preparseArgs
```
````

````{py:function} parseArgs(args: list[str]) -> tuple[arelle.RuntimeOptions.RuntimeOptions, dict[str, typing.Any]]
:canonical: arelle.CntlrCmdLine.parseArgs

```{autodoc2-docstring} arelle.CntlrCmdLine.parseArgs
```
````

````{py:function} createCntlrAndPreloadPlugins(uiLang: str | None, disablePersistentConfig: bool, arellePluginModules: dict[str, typing.Any]) -> CntlrCmdLine
:canonical: arelle.CntlrCmdLine.createCntlrAndPreloadPlugins

```{autodoc2-docstring} arelle.CntlrCmdLine.createCntlrAndPreloadPlugins
```
````

````{py:function} _configAndRunCntlr(options: arelle.RuntimeOptions.RuntimeOptions, arellePluginModules: dict[str, typing.Any]) -> tuple[None, None] | tuple[bottle.Bottle, None] | tuple[CntlrCmdLine, bool]
:canonical: arelle.CntlrCmdLine._configAndRunCntlr

```{autodoc2-docstring} arelle.CntlrCmdLine._configAndRunCntlr
```
````

````{py:function} configAndRunCntlr(options: arelle.RuntimeOptions.RuntimeOptions, arellePluginModules: dict[str, typing.Any]) -> CntlrCmdLine
:canonical: arelle.CntlrCmdLine.configAndRunCntlr

```{autodoc2-docstring} arelle.CntlrCmdLine.configAndRunCntlr
```
````

`````{py:class} ParserForDynamicPlugins(options: arelle.RuntimeOptions.RuntimeOptions)
:canonical: arelle.CntlrCmdLine.ParserForDynamicPlugins

```{autodoc2-docstring} arelle.CntlrCmdLine.ParserForDynamicPlugins
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.CntlrCmdLine.ParserForDynamicPlugins.__init__
```

````{py:method} add_option(*args: typing.Any, **kwargs: typing.Any) -> None
:canonical: arelle.CntlrCmdLine.ParserForDynamicPlugins.add_option

```{autodoc2-docstring} arelle.CntlrCmdLine.ParserForDynamicPlugins.add_option
```

````

````{py:method} add_option_group(featureGroup: optparse.OptionGroup, *args: typing.Any, **kwargs: typing.Any) -> None
:canonical: arelle.CntlrCmdLine.ParserForDynamicPlugins.add_option_group

```{autodoc2-docstring} arelle.CntlrCmdLine.ParserForDynamicPlugins.add_option_group
```

````

````{py:method} __getattr__(name: str) -> None
:canonical: arelle.CntlrCmdLine.ParserForDynamicPlugins.__getattr__

```{autodoc2-docstring} arelle.CntlrCmdLine.ParserForDynamicPlugins.__getattr__
```

````

`````

````{py:function} _pluginHasCliOptions(moduleInfo: dict[str, typing.Any]) -> bool
:canonical: arelle.CntlrCmdLine._pluginHasCliOptions

```{autodoc2-docstring} arelle.CntlrCmdLine._pluginHasCliOptions
```
````

````{py:function} _parseOptionsFile(optionsFile: str, parser: optparse.OptionParser) -> dict[str, typing.Any]
:canonical: arelle.CntlrCmdLine._parseOptionsFile

```{autodoc2-docstring} arelle.CntlrCmdLine._parseOptionsFile
```
````

`````{py:class} CntlrCmdLine(logFileName: str | None = None, uiLang: str | None = None, disable_persistent_config: bool = False)
:canonical: arelle.CntlrCmdLine.CntlrCmdLine

Bases: {py:obj}`arelle.Cntlr.Cntlr`

```{autodoc2-docstring} arelle.CntlrCmdLine.CntlrCmdLine
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.CntlrCmdLine.CntlrCmdLine.__init__
```

````{py:method} run(options: arelle.RuntimeOptions.RuntimeOptions, sourceZipStream: typing.Any = None, responseZipStream: typing.Any = None) -> bool
:canonical: arelle.CntlrCmdLine.CntlrCmdLine.run

```{autodoc2-docstring} arelle.CntlrCmdLine.CntlrCmdLine.run
```

````

````{py:method} internet_user_password(host: str, realm: str) -> tuple[str, str]
:canonical: arelle.CntlrCmdLine.CntlrCmdLine.internet_user_password

```{autodoc2-docstring} arelle.CntlrCmdLine.CntlrCmdLine.internet_user_password
```

````

````{py:method} showStatusOnPipe(message: str | None, clearAfter: int | None = None) -> None
:canonical: arelle.CntlrCmdLine.CntlrCmdLine.showStatusOnPipe

```{autodoc2-docstring} arelle.CntlrCmdLine.CntlrCmdLine.showStatusOnPipe
```

````

````{py:method} loadPackage(package: str, packageManifestName: str) -> None
:canonical: arelle.CntlrCmdLine.CntlrCmdLine.loadPackage

```{autodoc2-docstring} arelle.CntlrCmdLine.CntlrCmdLine.loadPackage
```

````

````{py:method} loadPackages(packages: list[str], packageManifestName: str) -> None
:canonical: arelle.CntlrCmdLine.CntlrCmdLine.loadPackages

```{autodoc2-docstring} arelle.CntlrCmdLine.CntlrCmdLine.loadPackages
```

````

`````