Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 0 additions & 95 deletions .github/workflows/worker.yml

This file was deleted.

2 changes: 1 addition & 1 deletion docs/.vale/styles/Microsoft/HeadingAcronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acro
level: warning
scope: heading
tokens:
- '[A-Z]{2,4}'
- "[A-Z]{2,4}"
2 changes: 1 addition & 1 deletion docs/.vale/styles/Microsoft/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ level: suggestion
scope: heading
match: $sentence
indicators:
- ':'
- ":"
exceptions:
- Azure
- CLI
Expand Down
2 changes: 1 addition & 1 deletion docs/.vale/styles/Microsoft/Quotes.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
extends: existence
message: 'Punctuation should be inside the quotes.'
message: "Punctuation should be inside the quotes."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks
level: error
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion docs/.vale/styles/Microsoft/Semicolon.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ nonword: true
scope: sentence
level: suggestion
tokens:
- ';'
- ";"
1 change: 0 additions & 1 deletion docs/.vale/styles/Microsoft/SentenceLength.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ scope: sentence
level: suggestion
max: 30
token: \b(\w+)\b

4 changes: 2 additions & 2 deletions docs/.vale/styles/Microsoft/Spacing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
level: error
nonword: true
tokens:
- '[a-z][.?!] {2,}[A-Z]'
- '[a-z][.?!][A-Z]'
- "[a-z][.?!] {2,}[A-Z]"
- "[a-z][.?!][A-Z]"
8 changes: 4 additions & 4 deletions docs/.vale/styles/Microsoft/Units.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ level: error
raw:
- '[a-zA-Z]+\s'
tokens:
- '(?:centi|milli)?meters'
- '(?:kilo)?grams'
- '(?:kilo)?meters'
- '(?:mega)?pixels'
- "(?:centi|milli)?meters"
- "(?:kilo)?grams"
- "(?:kilo)?meters"
- "(?:mega)?pixels"
- cm
- inches
- lb
Expand Down
2 changes: 1 addition & 1 deletion docs/.vale/styles/Microsoft/Vocab.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Verify your use of '%s' with the A-Z word list."
link: 'https://docs.microsoft.com/en-us/style-guide'
link: "https://docs.microsoft.com/en-us/style-guide"
level: suggestion
ignorecase: true
tokens:
Expand Down
7 changes: 7 additions & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,13 @@
]
},
"v2/cli/commands/evaluate",
{
"group": "license",
"pages": [
"v2/cli/commands/license/check",
"v2/cli/commands/license/activate"
]
},
"v2/cli/commands/migrate",
"v2/cli/commands/validate",
"v2/cli/commands/server",
Expand Down
15 changes: 13 additions & 2 deletions docs/v2/cli/commands/config/edit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ description: "Edit Flipt configuration"
flipt config edit [flags]
```

### Options
## Synopsis

Opens the Flipt configuration file in your default editor for making changes.

## Options

```
-h, --help help for edit
Expand All @@ -19,6 +23,13 @@ flipt config edit [flags]
--config string path to config file
```

### More Info
## Examples

```bash
flipt config edit
flipt config edit --config /path/to/config.yml
```

## More Info

See the [Configuration](/v2/configuration/overview) section of the documentation for more information.
15 changes: 13 additions & 2 deletions docs/v2/cli/commands/config/init.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ description: "Initialize Flipt configuration"
flipt config init [flags]
```

### Options
## Synopsis

Creates a new Flipt configuration file with default settings.

## Options

```
-y, --force Overwrite existing configuration file
Expand All @@ -20,6 +24,13 @@ flipt config init [flags]
--config string path to config file
```

### More Info
## Examples

```bash
flipt config init
flipt config init --force
```

## More Info

See the [Configuration](/v2/configuration/overview) section of the documentation for more information.
16 changes: 11 additions & 5 deletions docs/v2/cli/commands/evaluate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ description: "Evaluate a flag"
flipt evaluate [flagKey] [flags]
```

### Options
## Synopsis

Evaluates a feature flag against the Flipt instance and returns the evaluation result.

Supports watch mode for continuous evaluation.

## Options

```
-a, --address string address of Flipt instance. (default "http://localhost:8080")
Expand All @@ -22,14 +28,14 @@ flipt evaluate [flagKey] [flags]
-w, --watch enable watch mode.
```

### Examples
## Examples

```
$ flipt evaluate chat-enabled --context test=foo
```bash
flipt evaluate chat-enabled --context test=foo

{"flag_key":"chat-enabled","enabled":true,"reason":"DEFAULT_EVALUATION_REASON","request_id":"73d12ea1-65d7-401d-b0c7-f7a6b3d41dd6","request_duration_millis":0.894792,"timestamp":"2024-01-23T17:37:13.484716964Z"}
```

### More Info
## More Info

See the [Evaluation](/v2/concepts#evaluation) concepts section of the documentation for more information.
38 changes: 38 additions & 0 deletions docs/v2/cli/commands/license/activate.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "license activate"
description: "Activate a new Flipt Pro license"
---

```
flipt license activate [flags]
```

## Synopsis

Interactive wizard for activating a new Flipt Pro license.

The `activate` command provides a guided, text-based user interface that:

- Supports both Pro Monthly and Pro Annual license types
- Handles online and offline license configurations
- Automatically updates your Flipt configuration file
- Validates the license with the licensing service
- Provides clear step-by-step guidance through the activation process

## Options

```
--config string path to config file
-h, --help help for activate
```

## Examples

```bash
flipt license activate
flipt license activate --config /path/to/config.yml
```

## More Info

See the [Licensing](/v2/licensing) and [Flipt Pro](/v2/pro) documentation for more information about Pro features and licensing options.
38 changes: 38 additions & 0 deletions docs/v2/cli/commands/license/check.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "license check"
description: "Validate your Flipt Pro license"
---

```
flipt license check [flags]
```

## Synopsis

Validates your current license configuration and displays license status information.

The `check` command:

- Validates the license configuration in your Flipt config file
- Connects to the licensing service to verify license validity
- Displays your current license status and expiration
- Shows which Pro features are available with your license
- Provides guidance for unlicensed users

## Options

```
--config string path to config file
-h, --help help for check
```

## Examples

```bash
flipt license check
flipt license check --config /path/to/config.yml
```

## More Info

See the [Licensing](/v2/licensing) and [Flipt Pro](/v2/pro) documentation for more information about Pro features and licensing options.
23 changes: 16 additions & 7 deletions docs/v2/cli/commands/migrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,32 @@ title: "migrate"
description: "Run pending analytics database migrations"
---

This is automatically run when the server starts.
```
flipt migrate [flags]
```

## Synopsis

Runs pending analytics database migrations.

<Note>
This currently only supports Clickhouse analytics database migrations.
</Note>

```
flipt migrate [flags]
```

### Options
## Options

```
--config string path to config file
-h, --help help for migrate
```

### More Info
## Examples

```bash
flipt migrate
flipt migrate --config /path/to/config.yml
```

## More Info

See the [Analytics](/v2/configuration/analytics) section of the documentation for more information.
Loading