Quick Start

This guide will help you get started with AtlasUI quickly.

Web Interface

Starting the Server

# Start the web server
atlasui start

# Or with custom port
atlasui start --port 8080

# Or use the PORT environment variable
PORT=8080 atlasui start

Then open your browser to http://localhost:8000

Using the Dashboard

The dashboard provides an overview of your Atlas resources:

  • Organizations and projects

  • Cluster status across projects

  • Cluster details and management

  • Database user management

Command-Line Interface

Version Information

# Show version
atlascli --version
atlasui --version

List Projects

# List all projects
atlascli projects list

# List with pagination
atlascli projects list --page 2 --limit 50

Get Project Details

# Get specific project
atlascli projects get <project-id>

Manage Clusters

# List clusters in a project
atlascli clusters list <project-id>

# Get cluster details
atlascli clusters get <project-id> <cluster-name>

# Get cluster details as JSON
atlascli clusters get <project-id> <cluster-name> --json

API Usage

You can also use the Atlas client programmatically:

from atlasui.client import AtlasClient

# Create client
with AtlasClient() as client:
    # List projects
    projects = client.list_projects()
    print(projects)

    # Get a project
    project = client.get_project('project-id')
    print(project)

    # List clusters
    clusters = client.list_clusters('project-id')
    print(clusters)

    # Get a cluster
    cluster = client.get_cluster('project-id', 'cluster-name')
    print(cluster)

Next Steps