Get Started

Learn how to quickly get started with Configu. We'll use the Configu CLI and the Configu ConfigStore (Configu Cloud) to declare, initialize, and export a simple set of configuration data.

1. Install the Configu CLI (OSS)

Linux

MacOS

Windows

1curl https://cli.configu.com/install.sh | sh

2. Declare a ConfigSchema

configu init --get-started

3. Connect to Configu ConfigStore

configu login

tip

The Configu Cloud Store is a convenient way to get started with Configu, especially for users who are new to the platform. It is a cloud-based configuration management solution that is easy to use and requires minimal setup, with a free plan option. To get started with Configu Cloud, you'll need to register and create a new organization.

It's important to note that Configu SaaS Store is just one of many options for storing and managing configuration data with Configu. If you have specific requirements or preferences, you may wish to explore other ConfigStore options, such as using a database, a secret manager, or your own custom implementation.

4. Upsert Configs to ConfigSet

configu upsert \
  --store 'configu' --set 'development' --schema './get-started.cfgu.json' \
  --config "GREETING=hey" --config "SUBJECT=<YOUR_NAME>" \
&& configu upsert \
  --store 'configu' --set 'development/qa' --schema './get-started.cfgu.json' \
  -c "GREETING=welcome"

5. Export the configuration data

configu eval \
  --store 'configu' --set 'development/qa' --schema './get-started.cfgu.json' \
| configu export \
  --format "Dotenv" \
> ".env"

As a result, you will get a .env file with the configurations declared in the "get-started" ConfigSchema and their values from the "test" ConfigSet.

GREETING=welcome
SUBJECT=<YOUR_NAME>
MESSAGE=welcome, <YOUR_NAME>!

That's it! You now have a simple set of configuration data stored in the Configu Cloud, ready to be used in your application.

tip

To learn more about Configu and how to use it, you can continue to explore the documentation and join the Configu Discord channel, where you can ask questions and get help from the Configu team and other community members.

Edit this page