Json

Introduction

This guide will show you how to use JSON files to manage configurations via the Configu interface. Learn about the concept of stores.

Working with the store

CLI installation

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

CLI usage

Create the store URI as follows:

json-file://[path to json file]

CLI Upsert

configu upsert --set "example" --schema "example.cfgu.json" --store "json-file:// example.json" --config "FOO=value" --config "BAR=bar"

CLI Export

configu export --set "example" --schema "example.cfgu.json" --store "json-file:// example.json" --format "Dotenv"

CLI Delete

configu delete --set "example" --schema "example.cfgu.json" --store --store "json-file:// example.json"

SDK installation

Install the node.js SDK

// * Using yarn
yarn add @configu/node
// * Using npm
npm install --save @configu/node

SDK usage

import { Cfgu, Set, UpsertCommand, EvalCommand, DeleteCommand, JsonFileStore} from "@configu/node";
import path from "path";

const store = new JsonFileStore(path.resolve(__dirname, "./example.json"));
const schema = new Cfgu(path.resolve(__dirname, "./example.cfgu.json"));
const set = new Set("dev");

// * Example upsert command
await new UpsertCommand({ store, set, schema, configs: [{ key: "foo", value: "bar" }] }).run();

// * Example eval command
const configs = await new EvalCommand({ store, set, schema }).run();

// * Example delete command
await new DeleteCommand({ store, set, schema }).run();

References

To reference a value from this store, use the following reference format:

{{json-file://<path to json file>@[set/]<schema>[.key][?key=[key]]}}

Example:

{{json-file://path/to/file.json@example-set/example-schema.foo}}