LogoLogo
Bonsai (0.13) DocsGitHubDiscord CommunityGarden Enterprise
Bonsai (0.13)
Bonsai (0.13)
  • Welcome to Garden!
  • 🌸Overview
    • How Garden Works
    • Core Concepts
    • Adopting Garden
    • Garden vs Other Tools
  • 🌳Use Cases
    • Isolated On-Demand Preview Environments
    • Fast, Portable CI Pipelines that Run Anywhere
    • Shift Testing Left
    • Local Development With Remote Clusters
    • Jumpstart your Internal Developer Platform
  • 🌻Getting Started
    • Quickstart Guide
    • Installing Garden
    • Next Steps
  • 💐Tutorials
    • Your First Project
      • 1. Create a Garden Project
      • 2. Pick a Kubernetes Plugin
      • 3. Add Actions
      • 4. Add Tests
      • 5. Code Syncing (Hot Reload)
      • 6. Next Steps
  • 🌿Using Garden
    • About
    • Configuration Overview
    • Projects
    • Dashboard
    • Actions
    • Tests
    • Runs
    • Workflows
    • Variables and templating
    • Config Templates
    • Using the CLI
    • Modules
  • Kubernetes Plugins
    • About
    • Remote K8s Plugin Configuration
      • 1. Create a Cluster
        • AWS
        • GCP
        • Azure
      • 2. Configure Container Registry
        • AWS
        • GCP
        • Azure
        • Docker Hub
      • 3. Set Up Ingress, TLS and DNS
      • 4. Configure the Provider
    • Local K8s Plugin Configuration
      • 1. Install Local Kubernetes
      • 2. Configure the Provider
    • Ephemeral K8s Plugin Configuration
      • 1. Configure the Provider
      • 2. Login to the Garden dashboard
      • 3. Configure Ingress (optional)
      • 4. Retrieve Kubeconfig (optional)
    • Actions
      • Build
        • Container
      • Deploy
        • Kubernetes
        • Helm
        • Container
        • PersistentVolumeClaim
        • ConfigMap
      • Run and Test
        • Kubernetes Pod
        • Helm Pod
        • Kubernetes Exec
        • Container
    • Guides
      • In-Cluster Building
      • Minimal RBAC Configuration for Development Clusters
      • Deploying to Production
      • Using a Registry Mirror
  • ☘️Terraform Plugin
    • About
    • Plugin Configuration
    • Actions
  • 🌹Pulumi Plugin
    • About
    • Plugin Configuration
    • Actions
  • 🌼Other Plugins
    • Container
    • Exec (local scripts)
  • 🌷Guides
    • Migrating to Bonsai
    • Migrating from Docker Compose to Garden
    • Deprecations and updating to Cedar
    • Code Synchronization
    • Connecting a local application to a Kubernetes cluster (Local Mode)
    • Environments and namespaces
    • Using Garden in CircleCI
  • 🪷Advanced
    • Using Remote Sources
    • Custom Commands
  • 🎋Reference
    • Providers
      • conftest-container
      • conftest-kubernetes
      • conftest
      • container
      • ephemeral-kubernetes
      • exec
      • hadolint
      • jib
      • kubernetes
      • local-kubernetes
      • octant
      • otel-collector
      • pulumi
      • terraform
    • Action Types
      • Build
        • container Build
        • exec Build
        • jib-container Build
      • Deploy
        • configmap Deploy
        • container Deploy
        • exec Deploy
        • helm Deploy
        • kubernetes Deploy
        • persistentvolumeclaim Deploy
        • pulumi Deploy
        • terraform Deploy
      • Run
        • container Run
        • exec Run
        • helm-pod Run
        • kubernetes-exec Run
        • kubernetes-pod Run
      • Test
        • conftest-helm Test
        • conftest Test
        • container Test
        • exec Test
        • hadolint Test
        • helm-pod Test
        • kubernetes-exec Test
        • kubernetes-pod Test
    • Template Strings
      • Project template context
      • Environment template context
      • Provider template context
      • Action (all fields) template context
      • Action spec template context
      • Module template context
      • Remote Source template context
      • Project Output template context
      • Custom Command template context
      • Workflow template context
      • Template Helper Functions
    • Commands
    • Project Configuration
    • ConfigTemplate Reference
    • RenderTemplate Reference
    • Workflow Configuration
    • Garden Containers on Docker Hub
    • Module Template Configuration
    • Module Types
      • configmap
      • conftest
      • container
      • exec
      • hadolint
      • helm
      • jib-container
      • kubernetes
      • persistentvolumeclaim
      • pulumi
      • templated
      • terraform
  • 🌸Misc
    • FAQ
    • Troubleshooting
    • Telemetry
    • New Garden Cloud Version
  • Contributing to Garden
    • Contributor Covenant Code of Conduct
    • Contributing to the Docs
    • Setting up your developer environment
    • Developing Garden
    • Config resolution
    • Graph execution
Powered by GitBook
On this page
  • Getting Started
  • Live Page
  • Deploy and sync statuses
  • Logs view
  • Graph view
  • Action results
  • Command palette
  • Ephemeral clusters
  • Commands
  • User Settings
  • Dark mode
  • Access tokens
  • Want more?

Was this helpful?

  1. Using Garden

Dashboard

PreviousProjectsNextActions

Last updated 2 months ago

Was this helpful?

The is a web app that's available on Garden's free community tier that adds various functionality on top of the Garden CLI.

Key features include:

  • that you can spin up on demand

  • An interactive graph view

  • Command history across all your projects

  • Action log viewer (e.g. for viewing build logs)

  • Command palette for running any Garden command directly from the dashboard

  • "Live" logs viewer that lets you stream and interleave logs from both the Garden CLI and your runtime services

Getting Started

Then run the login command with the Garden CLI from your terminal:

garden login

And that's it! Next time you run Garden in your project you'll be able to use the dashboard. Projects are created automatically in the dashboard if they don't exist already.

If you're new to Garden, you can also follow the in-app onboarding guide.

Live Page

From the Live page you can view your project graph, stream logs in real time, and run any Garden command from the command palette.

The Live page is only available when Garden is running in dev mode. To get started, run the following from your terminal:

garden dev

Then follow the link to the Live page.

Deploy and sync statuses

You can view the statuses of your Deploy actions and syncs by expanding the command tray at the top of the page. From here you can also start and stop individual syncs.

This is e.g. useful if you're hopping between branches with a lot of changes and want to disable syncing while you do so.

Logs view

The Logs view streams all logs from the CLI by default. Here you can also change the log level on demand and filter on log lines.

You can also use the "Log sources" dropdown to stream logs from your actual services at runtime (i.e. the logs your applications write to stdout).

Graph view

The Graph view shows you the graph of all your actions and their statuses. To load the latest statuses you can click the "refresh" button on the left control panel. You can also run individual actions or view their logs by clicking on the nodes.

Action results

The Action results view shows you a list of actions that have been executed since you started the garden dev command. Here you can see their results, view logs and find ingress links for Deploy actions.

You can also see what actions are cached and the time you've saved by using Garden.

Command palette

You can open the command palette by pressing cmd+k on macOS or ctrl+k on Windows/Linux. It allows you to run any Garden command from the dashboard itself which is e.g. useful if you want to trigger commands while looking at logs. The command is then executed by the Garden CLI process running your machine.

Currently the Live page will only work on Chromium based browsers (e.g. Chrome, Brave, Ark) because of how it connects to the Garden CLI over a local websocket connection between the browser and the CLI process.

This is a bit embarrassing and we're working hard to fix it :)

Other pages will work as expected.

Ephemeral clusters

Commands

The Commands page shows you a list of historic commands. Both those you've run with the Garden CLI directly (e.g. garden deploy) and those you've run from within the dev console. You can click the commands to get a detail view of the command results.

User Settings

Dark mode

You can toggle dark/light mode via the user settings which you can access by clicking the Garden logo at the top left.

Access tokens

Under the user settings you can also create an access token so that you can e.g. connect to the dashboard from CI. The access token is set via the GARDEN_AUTH_TOKEN environment variable. For example:

GARDEN_AUTH_TOKEN=<my-access-token> garden deploy

In an upcoming release we'll be adding functionality for creating proper teams and service accounts for use in CI.

Want more?

The community dashboard contains a subset of the Garden Enterprise feature set. If you're looking for:

The dashboard is under heavy development and we're constantly improving it. Any and all feedback is greatly appreciated via .

First, go to the and sign up if you haven't already.

We currently only support signing up via GitHub but if you'd like to see other options.

Connect to live page, enable syncs, open ingress URL, and stream logs
Refresh action graph statuses, filter graph, and run an action
View action results, use the command palette, and view build logs

The Garden ephemeral clusters are managed via the dashboard. To get started, checkout .

...and a lot more—then checkout out our or !

🌿
GitHub issues
dashboard site
let us know
this guide
Secret management
Cloud workflows triggered by VCS events
Actionable usage insights
1-click preview environments
Automatic environment cleanup
User managment and access control
different plans
book a demo
Garden dashboard
Garden managed ephemeral clusters
The Garden dashboard
The graph in dark mode