Downloads:

7,536

Downloads of v 1.2.0:

21

Last Update:

20 Oct 2021

Package Maintainer(s):

Software Author(s):

  • ConfigCat

Tags:

configcat feature-flag feature-toggle

ConfigCat CLI

This is not the latest version of ConfigCat CLI available.

  • 1
  • 2
  • 3

1.2.0 | Updated: 20 Oct 2021

Downloads:

7,536

Downloads of v 1.2.0:

21

Maintainer(s):

Software Author(s):

  • ConfigCat

  • 1
  • 2
  • 3
ConfigCat CLI 1.2.0

This is not the latest version of ConfigCat CLI available.

  • 1
  • 2
  • 3

All Checks are Passing

3 Passing Tests


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Successful:

No detections found in any package files

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install ConfigCat CLI, run the following command from the command line or from PowerShell:

>

To upgrade ConfigCat CLI, run the following command from the command line or from PowerShell:

>

To uninstall ConfigCat CLI, run the following command from the command line or from PowerShell:

>

Deployment Method:

📝 NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade configcat -y --source="'INTERNAL REPO URL'" --version="'1.2.0'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade configcat -y --source="'INTERNAL REPO URL'" --version="'1.2.0'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install configcat
  win_chocolatey:
    name: configcat
    version: '1.2.0'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'configcat' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '1.2.0'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller configcat
{
    Name     = "configcat"
    Version  = "1.2.0"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'configcat':
  ensure   => '1.2.0',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved by moderator gep13 on 01 Nov 2021.

Description

The ConfigCat Command Line Interface allows you to interact with the ConfigCat Management API via the command line. It supports most functionality found on the ConfigCat Dashboard. You can manage ConfigCat resources like Feature Flags, Targeting / Percentage rules, Products, Configs, Environments, and more.


tools\configcat.exe
md5: F8D25AE112B3D0516BCF1A0C3F335749 | sha1: 9CBF3C56D62463524360CCE31515602562801D55 | sha256: AA61B7F584063A214704F5580DB21897F79B588B27856D94E105E134B3214257 | sha512: 79C5F8EAFB0C32D85B152FA0C0FD8EE3F0F81FC5A95D6D32045CA68F6ABBD469DB258D5A969C68DB8B52D5D8144A2F3A5E10B86B034A23CE7CADF85AADD345FF
tools\LICENSE.txt
MIT License

Copyright (c) 2021 ConfigCat

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
tools\README.md
# Command Line Interface for ConfigCat

[![ConfigCat CLI CI](https://github.com/configcat/cli/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/configcat/cli/actions/workflows/ci.yml)

The ConfigCat Command Line Interface allows you to interact with the <a target="_blank" href="https://configcat.com/docs/advanced/public-api">Public Management API</a> via the command line. It supports most functionality found on the ConfigCat Dashboard. You can manage ConfigCat resources like Feature Flags, Targeting / Percentage rules, Products, Configs, Environments, and more.

<img src="assets/teaser.gif" alt="ConfigCat CLI Feature Flag Create"/>

See the <a target="_blank" href="https://configcat.github.io/cli/">command reference documentation</a> for more information about each available command.

## About ConfigCat
ConfigCat is a feature flag and configuration management service that lets you separate releases from deployments. You can turn your features ON/OFF using <a href="https://app.configcat.com" target="_blank">ConfigCat Dashboard</a> even after they are deployed. ConfigCat lets you target specific groups of users based on region, email or any other custom user attribute.

ConfigCat is a <a href="https://configcat.com" target="_blank">hosted feature flag service</a>. Manage feature toggles across frontend, backend, mobile, desktop apps. <a href="https://configcat.com" target="_blank">Alternative to LaunchDarkly</a>. Management app + feature flag SDKs.

## Getting Started
The following instructions will guide you through the first steps to start using this tool.

### Installation
You can install the CLI on multiple operating systems using the following methods.

<details>
  <summary><strong>Homebrew (macOS / Linux)</strong></summary>

Install the CLI from [ConfigCat tap](https://github.com/configcat/homebrew-tap) with [Homebrew](https://brew.sh) by executing the following command:
```bash
brew tap configcat/tap
brew install configcat
```

</details>

<details>
  <summary><strong>Snap (Linux)</strong></summary>

Install the CLI from [Snapcraft](https://snapcraft.io/) by executing the following command:
```bash
sudo snap install configcat
```

</details>

<details>
  <summary><strong>Scoop (Windows)</strong></summary>

Install the CLI from [ConfigCat bucket](https://github.com/configcat/scoop-configcat) with [Scoop](https://scoop.sh) by executing the following command:
```bash
scoop bucket add configcat https://github.com/configcat/scoop-configcat
scoop install configcat
```

</details>

<details>
  <summary><strong>Chocolatey (Windows)</strong></summary>

Install the CLI from [Chocolatey](https://chocolatey.org/) by executing the following command:
```powershell
choco install configcat
```

</details>

<details>
  <summary><strong>Docker</strong></summary>

The CLI can be executed from a [Docker](https://www.docker.com/) image.
```bash
docker pull configcat/cli
```
An example of how to scan a repository for feature flag & setting references with the docker image.
```bash
docker run --rm \
    --env CONFIGCAT_API_HOST=<API-HOST> \
    --env CONFIGCAT_API_USER=<API-USER> \
    --env CONFIGCAT_API_PASS=<API-PASSWORD> \
    -v /path/to/repository:/repository \
  configcat/cli scan "/repository" --print --config-id <CONFIG-ID>
```

</details>

<details>
  <summary><strong>Install Script</strong></summary>

On Unix platforms, you can install the CLI by executing an install script.
```bash
curl -fsSL "https://raw.githubusercontent.com/configcat/cli/main/scripts/install.sh" | bash
```

By default, the script downloads the OS specific artifact from the latest [GitHub Release](https://github.com/configcat/cli/releases) with `curl` and moves it into the `/usr/local/bin` directory.

It might happen, that you don't have permissions to write into `/usr/local/bin`, then you should execute the install script with `sudo`.

```bash
curl -fsSL "https://raw.githubusercontent.com/configcat/cli/main/scripts/install.sh" | sudo bash
```

The script accepts the following input parameters:

Parameter | Description | Default value
--------- | ----------- | -------------
`-d`, `--dir` | The directory where the CLI should be installed. | `/usr/local/bin`
`-v`, `--version` | The desired version to install. | `latest`
`-a`, `--arch` | The desired architecture to install. | `x64`

The possible **architecture** values for Linux: `x64`, `musl-x64`, `arm`, `arm64`.

> For macOS, the architecture is fixed to `x64`, but we plan the support of Apple silicon in the future.

**Script usage examples**:

*Custom installation directory*:
```bash
curl -fsSL "https://raw.githubusercontent.com/configcat/cli/main/scripts/install.sh" | bash -s -- -d=/path/to/install
```

*Install a different version*:
```bash
curl -fsSL "https://raw.githubusercontent.com/configcat/cli/main/scripts/install.sh" | bash -s -- -v=1.4.2
```

*Install with custom architecture*:
```bash
curl -fsSL "https://raw.githubusercontent.com/configcat/cli/main/scripts/install.sh" | bash -s -- -a=arm
```

</details>

<details>
  <summary><strong>Standalone executables</strong></summary>

You can download the executables directly from [GitHub Releases](https://github.com/configcat/cli/releases) for your desired platform.

</details>

### Configuration
After a successful installation, the CLI must be configured with your <a target="_blank" href="https://app.configcat.com/my-account/public-api-credentials">ConfigCat Management API credentials</a>.

You can do this by using the `configcat setup` command.

<img src="assets/setup.gif" alt="ConfigCat CLI" />

#### Environment Variables
Besides the configuration command above, the CLI can read your credentials from the following environment variables.

Name | Description |
--------- | ----------- |
`CONFIGCAT_API_HOST` | The Management API host. (default: api.configcat.com) | 
`CONFIGCAT_API_USER` | The Management API basic authentication username. |
`CONFIGCAT_API_PASS` | The Management API basic authentication password. | 

> When any of these environment variables are set, the CLI will use them over the local values set by the `configcat setup` command.

## Useful Links
- [Documentation](https://configcat.com/docs/advanced/cli)
- [ConfigCat](https://configcat.com)
- [Blog](https://configcat.com/blog)
tools\VERIFICATION.txt
VERIFICATION
Verification is intended to assist the Chocolatey moderators and community
in verifying that this package's contents are trustworthy.

This package is published and maintained by ConfigCat.

Steps to verify the checksum of the standalone executable (configcat.exe) included:
- Download the zipped executable from the official release page and extract it. 
  The URL of this version: https://github.com/configcat/cli/releases/download/v1.2.0/configcat-cli_1.2.0_win-x64.zip
- Execute the 'Get-FileHash' PowerShell command on the extracted 'configcat.exe' to obtain the checksum.
- The printed hash must match with the checksum value for 'configcat.exe' showed on this package's Chocolatey page.

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Add to Builder Version Downloads Last Updated Status
ConfigCat CLI 1.5.1 1858 Monday, July 4, 2022 Approved
ConfigCat CLI 1.5.0 5412 Thursday, April 28, 2022 Approved
ConfigCat CLI 1.4.1 25 Monday, April 4, 2022 Approved
ConfigCat CLI 1.4.0 21 Tuesday, February 22, 2022 Approved
ConfigCat CLI 1.3.1 26 Saturday, January 22, 2022 Approved
ConfigCat CLI 1.3.0 32 Saturday, November 13, 2021 Approved
ConfigCat CLI 1.2.2 27 Monday, October 25, 2021 Approved
ConfigCat CLI 1.2.1 30 Thursday, October 21, 2021 Approved
ConfigCat CLI 1.2.0 21 Wednesday, October 20, 2021 Approved

This package has no dependencies.

Discussion for the ConfigCat CLI Package

Ground Rules:

  • This discussion is only about ConfigCat CLI and the ConfigCat CLI package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or ConfigCat CLI, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus