Getting started

Here is a short "getting started" guide to using Structurizr, and creating software architecture models using the client libraries.

1. Sign up for a free account

Before you can do anything, you will need to sign up for a free Structurizr account using the sign up page.

Sign up for a free account

2. Sign in

Once you've signed up for an account, you can sign in to get to your dashboard page.

The dashboard page

3. Create a new cloud workspace

Next, create a new cloud workspace by clicking the "Create a new cloud workspace" link. This will create a new empty workspace, which will be used to store your software architecture model.

Create a new cloud workspace

4. Clone one of the quick start projects

Software architecture models are created by writing code, using the Structurizr for Java or Structurizr for .NET client libraries. The easiest way to get started is to clone one of the following quick start projects:

5. Modify the workspace ID, API key and secret

If you load the project into your IDE of choice, you'll see that the quick start projects include a simple console application. There are some constants at the top of the source code file that need to be changed to reflect the details of the workspace you created.

private static final long WORKSPACE_ID = 1234;
private static final String API_KEY = "key";
private static final String API_SECRET = "secret";
private const long WorkspaceId = 1234;
private const string ApiKey = "key";
private const string ApiSecret = "secret";

You can find the workspace ID, API key and secret on your dashboard, by clicking the "Show more..." button associated with the workspace.

Workspace ID, API key and secret

6. Run the console application

Running the console application will create a software architecture model and upload it, via the web API, to Structurizr.

7. Open the workspace in Structurizr

Clicking the workspace name/thumbnail on your dashboard will open the workspace summary, from where you can open the diagram viewer to see the diagram that was created by the console application.

The workspace in the diagram editor

Here, you can move the diagram elements around and change the paper size. The diagram layout can be saved by clicking the save button.

For more information

See Structurizr for Java or Structurizr for .NET for more details about what you can do with the client libraries, and here are a few videos demonstrating some of the basic features of Structurizr.