> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/cli/cligetargs.md).

# CLIGetArgs

This method will parse the cli arguments and return a struct of the following:

* `options` - A struct of the options
* `positionals` - An array of the positional arguments

The options can be provided in the following formats:

* `--option` - A boolean option
* `--option=value` - An option with a value
* `--option="value"` - An option with a quoted value
* `--option='value'` - An option with a quoted value
* `-o=value` - A shorthand option with a value
* `-o` - A shorthand boolean option
* `--!option` - A negation option

For example, the following cli arguments:

```
 --debug --!verbose --bundles=Spec -o='/path/to/file' -v my/path/template
 
```

Will be parsed into the following struct:

```
 {
 "options" :  {
    	"debug": true,
   	"verbose": false,
  	"bundles": "Spec",
 	   	"o": "/path/to/file",
 	   	"v": true
 },
 "positionals": [ "my/path/template" ]
 
```

## Some Ground Rules

* Options are prefixed with --
* Shorthand options are prefixed with -
* Options can be negated with --! or --no-
* Options can have values separated by =
* Values can be quoted with single or double quotes
* Repeated options will override the previous value

## Method Signature

```
CLIGetArgs()
```

### Arguments

This function does not accept any arguments

## Examples

## Related

* [CLIClear](/boxlang-language/reference/built-in-functions/cli/cliclear.md)
* [CLIExit](/boxlang-language/reference/built-in-functions/cli/cliexit.md)
* [CLIRead](/boxlang-language/reference/built-in-functions/cli/cliread.md)


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/cli/cligetargs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.