> For the complete documentation index, see [llms.txt](https://docs.workflowgen.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.workflowgen.com/cli/1.0.0/installation.md).

# Installation

The WorkflowGen CLI has been developed with the .NET 5 framework. You need to install the appropriate SDK before installing the tool.

The CLI is compatible with Windows, Linux and macOS. You can download the SDK at this link: <https://dotnet.microsoft.com/download/dotnet/5.0>

## Prerequisite

The WorkflowGen CLI works with the GraphQL API, so be sure that GraphQL is activated on your instance.&#x20;

## dotnet tool

The CLI is available as a dotnet tool. The package is available at this link: <https://www.nuget.org/packages/WorkflowGen.Cli/1.0.0>.

### Installation

Open a terminal and execute the following command to install the WorkflowGen CLI:

```
dotnet tool install --global WorkflowGen.Cli --version 1.0.0
```

### Uninstallation

Open a terminal and execute the following command to uninstall the WorkflowGen CLI:

```
dotnet tool uninstall --global WorkflowGen.Cli --version 1.0.0
```

## Getting started

To interact with your WorkflowGen application, you first need to log in. Use the [`login`](/cli/1.0.0/list-of-commands.md#login) command to do this.

#### 📌 Example

```
wfg login http://localhost/wfgen -u wfgen_admin -p AdminPassword
```


---

# 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://docs.workflowgen.com/cli/1.0.0/installation.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.