Skip to content

QUICKSTART / YOUR FIRST PROJECT

Try one complete workflow

Use a desktop browser and dummy configuration to evaluate import, team access, change history, and export. No CLI installation or production credentials are needed.

Members can access every project and environment in their organization. Use a new organization for this exercise and read the security and access model before importing real credentials.

1. Create an organization and a project

Create your account or open the dashboard. Create or select an organization, then create a project named “Demo app.” The free plan supports one project, 50 variables per environment, and three members.

Open the project and select LOCAL. Environment names organize configuration; they do not restrict access for other members.

2. Import dummy configuration

Select “Import .env” and paste these example values into the content field, then select “Upload Secrets.” They are placeholders for this exercise.

DEMO_API_KEY=example-only-not-a-real-credential
DEMO_BASE_URL=https://example.invalid
FEATURE_ENABLED=true

The import marks values sensitive by default. Keep that setting for credentials. Marking a value non-sensitive disables its KMS encryption.

3. Invite a second developer

As the organization administrator, open “Members” and invite your teammate by email. Have them accept the invitation, select the same organization, open “Demo app,” and choose LOCAL.

Ask them to select “Export” and verify that the three dummy variables are present. Export retrieves values in plaintext; protect exported files even when you later repeat this with real credentials.

4. Make a change and inspect its record

Edit DEMO_BASE_URL to https://updated.example.invalid. Open the project's “Activity” tab to find the update record and its actor and timestamp.

The record contains metadata rather than previous values. Ask your teammate to export LOCAL again to retrieve the updated value. A previous export does not update automatically.

5. Export and decide whether the workflow fits

Export LOCAL once more and check that you can retrieve the configuration without assistance. Repeat export for every environment you need when migrating away; there is no single archive export of an entire organization.

If your application already reads a .env file or environment variables, this workflow requires no Keyrua SDK. Keep real exported files out of version control. Deleting the demo project removes its variables and change records.

Continue in your terminal

The CLI is available on npm. With Node.js 24 or newer, install it and run these commands from your application's directory. Choose the same organization during browser login and replace “demo-app” with your actual project slug.

Install the CLI
npm install --global @keyrua/cli
Connect your demo project
keyrua login
keyrua init --project demo-app --env local
keyrua run --project demo-app --env local -- node server.js

Replace node server.js with your application command. The CLI injects the selected environment into that process. Read the CLI documentation for installation, push and pull, configuration, and troubleshooting.