> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/platform-administration/administration/digibeectl/digibeectl-syntax.md).

# Digibeectl syntax

Understand Digibeectl syntax.

Digibeectl uses the GET and SET commands so that you can easily configure your customer. The information is automatically saved in a configuration file, which uses the format below with the following commands:

```
digibeectl [command] [subcommand | resource] [flags]
```

* `command:` specifies the operation that you want to perform on one or more resources. For example **completion**, **config**, **create**, **delete**, **get**, **help**, **info**, **set**, **update**, **version**.
* `subcommand:` specifies a specific action or category within a command that further refines the operation. For example, in the config command, you might have subcommands like **set**, **get**, **view**, **list**, **use**, **delete**.
* `resource:` specifies resource to be accessed. For example api-mgmt-credentials, api-mgmt-url, config, deployment, deployment-history, pipeline.
* `flags:` specifies optional flags. For example, you can use the -e or --environment to filter deployments by environment (default "test").


---

# 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.digibee.com/documentation/platform-administration/administration/digibeectl/digibeectl-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.