Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drujensen/ldsync
The Launch Darkly Sync Utility
https://github.com/drujensen/ldsync
Last synced: 10 days ago
JSON representation
The Launch Darkly Sync Utility
- Host: GitHub
- URL: https://github.com/drujensen/ldsync
- Owner: drujensen
- License: mit
- Created: 2022-03-12T13:34:58.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-01T19:05:15.000Z (over 1 year ago)
- Last Synced: 2024-10-25T01:35:41.085Z (about 2 months ago)
- Language: Crystal
- Size: 50.8 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The Launch Darkly Sync Utility
This utility will manage your Launch Darkly flags using a configuration file.
It will create the flags if they don't exist and then turn on/off the flags based on the status.
## Installation
To install using [brew on Mac or Linux](https://brew.sh/):
Install ldsync
```sh
brew tap drujensen/ldsync
brew install ldsync
```
You will need to a [Launch Darkly API access token](https://docs.launchdarkly.com/home/account-security/api-access-tokens) to use this utility.
You should add this token to your shell profile or set this environment variable before using:
```sh
export LD_TOKEN="{API access token}"
```
## Usage
To start off, we need to create a config file. The default location of the config file is: `config/ldconfig.yml`
### Initialize config file
To create an example config file:
```sh
ldsync init
```
If you need to specify a different location, you will need to use the `-c` flag:
```sh
ldsync init -c example.yml
```
Here is what the config file looks like:
```yaml
project: {project-key}
environment: {environment-key}
flags:
- key: example-flag
name: Example Flag
enabled: true
```
### Query Projects
To see the list of all projects:
```
ldsync projects
```
### Query Environments per Project
To see the list of environments for a project:
```
ldsync -p {project-name} envs
```
### Query Flags per Project and Environment
To see the listt of flags per project and environment:
```
ldsync -p {project-key} -e {environment-key} flags
```
### Push to Launch Darkly
After setting up the config file, you can push the changes to Launch Darkly. This will create the project, environment, flags, and value. If the resource already exists, it will skip it. Your access token will need permission to create the resources that do not already exist.
To push the changes:
```sh
ldsync push
```
### Pull from Launch Darkly
If you make changes in Launch Darkly UI and you want to pull those changes down into the config file, you can do that will the pull command. This will replace all the flags in the config file with the ones setup in Launch Darkly. It will pull the settings based on the environment you have chosen.
To pull the changes:
```sh
ldsync pull
```
## Enviroment Variables
There are cases where you want to override the Token, Project or Environment. You can do this using environment variables.
The following environment variables are supported:
```sh
LD_TOKEN={Launch Darkly Access Token}
LD_PROJECT={Launch Darkly Project Key}
LD_ENVIRONMENT={Launch Darkly Environment Key}
```
## Development
This was built using the [Crystal Language](https://crystal-lang.org/).
To build the application:
```bash
crystal build src/ldsync.cr
```
To run the application:
```bash
bin/ldsync
```
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Dru Jensen](https://github.com/drujensen) - creator and maintainer