Get Started

Learn how to quickly get started with Configu. We'll use the Configu's CLI and the Configu's Saas Configuration Store to decalre, initalize, and export a simple set configuration data.

1. Install the Configu CLI

Linux

MacOS

Windows

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

2. Declare a ConfigSchema

configu init --get-started

3. Connect a ConfigStore

configu store upsert --type "configu"

note

Configu SaaS Store is a convenient way to get started with Configu, especially for users who are new to the platform. It provides a cloud-based configuration management solution that is easy to use and requires minimal setup. To get started with Configu SaaS Store, 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 Config values to a "test" ConfigSet

configu upsert \
--store "configu" --set "test" --schema "./get-started.cfgu.json" \
--config "GREETING=hey" --config "SUBJECT=<YOUR_NAME>"

5. Export the configuration data

configu export \
--store "configu" --set "test" --schema "./get-started.cfgu.json" \
--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=hey
SUBJECT=<YOUR_NAME>
BAZ=hey, <YOUR_NAME>!

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

To learn more about Configu and how to use it, you can continue to expolre 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