# @progressively/cli

> CLI to manage Progressively feature flags

Latest version **1.0.0-alpha.5** (published 2024-02-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @progressively/cli
pnpm add @progressively/cli
yarn add @progressively/cli
bun add @progressively/cli
```

Provides the commands `psy`, `progressively`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-alpha.5 |
| Published | 2024-02-23 |
| First published | 2023-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=16.0.0 |
| Dependencies | 12 |
| Unpacked size | 39.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Maxime BLANC @jean-smaug |
| Maintainers | jean-smaug, skahrz |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@progressively/cli
- Repository: https://github.com/progressively-crew/cli
- Issues: https://github.com/jean-smaug/cli/issues
- npm.io page: https://npm.io/package/@progressively/cli

## Dependencies (12)

- [axios](https://npm.io/package/axios.md) ^1.6.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.1.1
- [prettier](https://npm.io/package/prettier.md) ^3.0.3
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^3.10.8
- [@oclif/color](https://npm.io/package/@oclif/color.md) ^1.0.13
- [@types/axios](https://npm.io/package/@types/axios.md) ^0.14.0
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.201
- [@changesets/cli](https://npm.io/package/@changesets/cli.md) ^2.26.2
- [@types/fs-extra](https://npm.io/package/@types/fs-extra.md) ^11.0.4
- [@inquirer/prompts](https://npm.io/package/@inquirer/prompts.md) ^3.3.0
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^6.0.5

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.0-alpha.5 (latest) — 2024-02-23
- 1.0.0-alpha.4 — 2023-12-13
- 1.0.0-alpha.3 — 2023-12-08
- 1.0.0-alpha.2 — 2023-11-22
- 1.0.0-alpha.1 — 2023-11-20

## README

# @progressively/cli

Progressively is a simple, lightweight and OpenSource feature flag software.

This repository contains the CLI

- [x] Administrator account creation
- [x] Authentication
- [x] Project creation/deletion
- [x] Flag manipulation
- [x] Types generation

## Quickstart

```bash
npm i -g @progressively/cli
progressively duck
```

## Demo

![demo-video](./docs/demo.gif)

## Summary

<!-- toc -->
* [@progressively/cli](#progressivelycli)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ npm install -g @progressively/cli
$ progressively COMMAND
running command...
$ progressively (--version)
@progressively/cli/1.0.0-alpha.5 darwin-arm64 node-v18.17.1
$ progressively --help [COMMAND]
USAGE
  $ progressively COMMAND
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`progressively config`](#progressively-config)
* [`progressively duck`](#progressively-duck)
* [`progressively flag`](#progressively-flag)
* [`progressively help [COMMANDS]`](#progressively-help-commands)
* [`progressively login`](#progressively-login)
* [`progressively me`](#progressively-me)
* [`progressively project`](#progressively-project)
* [`progressively register`](#progressively-register)
* [`progressively types`](#progressively-types)

## `progressively config`

Configure the Progressively CLI

```
USAGE
  $ progressively config [--show]

FLAGS
  --show  Display the current configuration for the user

DESCRIPTION
  Configure the Progressively CLI

EXAMPLES
  $ progressively config
```

_See code: [src/commands/config.ts](https://github.com/progressively-crew/cli/blob/v1.0.0-alpha.5/src/commands/config.ts)_

## `progressively duck`

Try it, you won't regret it

```
USAGE
  $ progressively duck

DESCRIPTION
  Try it, you won't regret it

EXAMPLES
  $ progressively duck
```

_See code: [src/commands/duck.ts](https://github.com/progressively-crew/cli/blob/v1.0.0-alpha.5/src/commands/duck.ts)_

## `progressively flag`

Manipulate flags

```
USAGE
  $ progressively flag [-C] [--create-only]

FLAGS
  -C, --create   Create a flag and update existing
  --create-only  Only create a flag

DESCRIPTION
  Manipulate flags

EXAMPLES
  $ progressively flag
```

_See code: [src/commands/flag.ts](https://github.com/progressively-crew/cli/blob/v1.0.0-alpha.5/src/commands/flag.ts)_

## `progressively help [COMMANDS]`

Display help for progressively.

```
USAGE
  $ progressively help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for progressively.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.5/src/commands/help.ts)_

## `progressively login`

Authenticate to store tokens in config

```
USAGE
  $ progressively login

DESCRIPTION
  Authenticate to store tokens in config

EXAMPLES
  $ progressively login
```

_See code: [src/commands/login.ts](https://github.com/progressively-crew/cli/blob/v1.0.0-alpha.5/src/commands/login.ts)_

## `progressively me`

Provide fullname and email of the current user

```
USAGE
  $ progressively me

DESCRIPTION
  Provide fullname and email of the current user

EXAMPLES
  $ progressively me
```

_See code: [src/commands/me.ts](https://github.com/progressively-crew/cli/blob/v1.0.0-alpha.5/src/commands/me.ts)_

## `progressively project`

Manage project (select current, create or delete one)

```
USAGE
  $ progressively project [-C] [-D]

FLAGS
  -C, --create  Create a project before selection
  -D, --delete  Delete a project

DESCRIPTION
  Manage project (select current, create or delete one)

EXAMPLES
  $ progressively project
```

_See code: [src/commands/project.ts](https://github.com/progressively-crew/cli/blob/v1.0.0-alpha.5/src/commands/project.ts)_

## `progressively register`

Register an admin user

```
USAGE
  $ progressively register

DESCRIPTION
  Register an admin user

EXAMPLES
  $ progressively register
```

_See code: [src/commands/register.ts](https://github.com/progressively-crew/cli/blob/v1.0.0-alpha.5/src/commands/register.ts)_

## `progressively types`

Generate types based on your Progressively instance

```
USAGE
  $ progressively types

DESCRIPTION
  Generate types based on your Progressively instance

EXAMPLES
  $ progressively types
```

_See code: [src/commands/types.ts](https://github.com/progressively-crew/cli/blob/v1.0.0-alpha.5/src/commands/types.ts)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/@progressively/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
