Usage

This section provides step-by-step guidance on how to use Depictio — from first login to advanced CLI workflows.

---

Getting Started

New to Depictio? Start here.

• Get Started

  ---

  First login, project creation, and your first dashboard in minutes

  Getting Started Guide

---

Guides

Hands-on guides for common tasks in the web interface.

Page	Description
Web UI	Navigate and use the Depictio web interface
Dashboard Creation	Create and configure interactive dashboards
Using the Dashboard	Explore data through filters and selections

• Web UI

  ---

  Navigate the Depictio interface

  Web UI Guide

• Dashboard Creation

  ---

  Build and configure interactive dashboards

  Dashboard Creation

• Using the Dashboard

  ---

  Explore your data with filters and selections

  Dashboard Usage

---

Projects

Everything you need to configure and manage Depictio projects.

Page	Description
Guide	Project types (Basic, Advanced, Template) and lifecycle
YAML Examples	Configuration patterns with annotated examples
Full Reference	Complete YAML field reference

• Projects Guide

  ---

  Understand project types and the full project lifecycle

  Projects Guide

• YAML Examples

  ---

  Annotated configuration patterns for every use case

  YAML Examples

• Full Reference

  ---

  Complete reference for every YAML configuration field

  Reference

---

CLI

Command-line tools for data ingestion, recipes, and templates.

Page	Description
Usage	All CLI commands with options and examples
Minimal YAML Config	Minimal project YAML to get started
Recipes	Data transformation recipes for bioinformatics pipelines
Templates	One-command project setup for nf-core pipelines

• :material-terminal:{ .lg .middle } CLI Usage

  ---

  Full reference for every depictio command

  CLI Reference

• Recipes

  ---

  Transform raw pipeline output into dashboard-ready tables

  Recipes Guide

• Templates

  ---

  Set up a complete nf-core project with a single command

  Templates Guide

---

Administration

Operational tasks for managing Depictio deployments.

Page	Description
Project Migration	Move projects between Depictio instances

• Project Migration

  ---

  Non-destructively migrate projects between Depictio instances

  Migration Guide

---

Special Modes

Alternative authentication and access configurations.

Page	Description
Authentication Modes	Configure authentication for your deployment
Unauthenticated Mode	Quick access without login (legacy)