Getting Started

Get up and running with Unmold in minutes. This guide walks you through setting up your account, securing access, and publishing your first module.

By the end of this section, you’ll have a working module published and ready to be consumed across your environments.

What You’ll Do

This guide follows a simple, end-to-end workflow:

1. Create your Unmold account
2. Set up authentication for CLI and API access
3. Publish your first module
4. Understand subscription limits and usage

Recommended Reading Order

Follow these steps in order to get the best onboarding experience:

• Set up your user account Create your account and access the Unmold console.

• Create and manage API tokens Generate tokens for secure CLI and CI/CD authentication.

• Publish your first module Walk through a complete publishing flow using the CLI.

• Manage subscriptions Understand plan limits, usage, and billing controls.

What You’ll Learn

As you complete this guide, you’ll learn how to:

• Authenticate securely using user tokens
• Publish versioned modules using the CLI
• Validate and manage modules in the console
• Integrate Unmold into your development and CI workflows

Before You Begin

Make sure you have:

• An environment with OpenTofu installed (documentation)
• Access to a terminal for running CLI commands
• Permissions to create and manage resources in your Unmold account

Next Step

Start by setting up your user account to access the Unmold console.

📄️ Setting Up Your User Account

To publish and consume modules in Unmold, you first need to create a user account.

📄️ Managing API Tokens

API tokens are used to authenticate with Unmold from the CLI and CI/CD systems.

📄️ Publish Your First Module

In this step, you will publish your first module to Unmold and verify that it can be used in OpenTofu.

📄️ Manage Subscription

Subscription plans control usage limits in Unmold, such as how many modules you can publish.