@formalco/pulumi/README.md

A Pulumi package for creating and managing Formal resources.

<a href="https://joinformal.com">
    <img src="https://raw.githubusercontent.com/formalco/pulumi-formal/refs/heads/main/.github/formal_logo.svg" alt="Formal logo" title="Formal" align="right" height="50" />
</a>

# Formal Resource Provider

[joinformal.com](https://joinformal.com)

The Formal Resource Provider allows for the full lifecycle management of Formal resources.

## Installing

This package is available for several languages/platforms:

### Node.js (JavaScript/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either `npm`:

```bash
npm install @formalco/pulumi
```

or `yarn`:

```bash
yarn add @formalco/pulumi
```

### Python

To use from Python, install using `pip`:

```bash
pip install pulumi_formal
```

### Go

To use from Go, use `go get` to grab the latest version of the library:

```bash
go get github.com/formalco/pulumi-formal/sdk/go/v1
```

### .NET

To use from .NET, install using `dotnet add package`:
```bash
dotnet add package Formal.Pulumi
```

## Configuration

The following configuration points are available:
- `formal:apiKey` - (Required) The API key used to access the Formal control plane. For more information, see the [API keys documentation page.](https://docs.joinformal.com/tools/api-keys)

## Reference

For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/formal/api-docs/).