Skip to content
/ sdm Public

A minimal CLI tool for managing SigNoz dashboards.

Notifications You must be signed in to change notification settings

Creator54/sdm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SigNoz Dashboard Manager (sdm)

A minimal CLI tool for managing SigNoz dashboards.

Install

git clone https://github.com/creator54/sdm.git
cd sdm && pip install -e .

Using Nix

If you have Nix with flakes enabled, you can run the tool directly:

nix run --refresh github:creator54/sdm

# Or from local checkout
nix run --refresh .#

To install into your environment:

nix profile install --refresh github:creator54/sdm

# Or from local checkout
nix profile install --refresh .#

Configure

Using .env:

[email protected]
SIGNOZ_PASSWORD=your_password
SIGNOZ_URL=http://localhost:3301

Or CLI:

# Using default URL (http://localhost:3301)
sdm -l -e [email protected] -p your_password

# Using custom URL
sdm -l -e [email protected] -p your_password -u http://your.signoz.url:3301

Usage

Basic Commands

sdm ls                      # List dashboards
sdm cfg                     # Show config
sdm add                     # Browse & select dashboards from SigNoz/dashboards
sdm add dash.json           # Add specific dashboard
sdm rm UUID                 # Remove by UUID
sdm rm -T "*Metrics*"       # Remove by title pattern (glob-style)
sdm rm -a                   # Remove all dashboards

Options

Flag Description
-l Login to SigNoz
-u Custom API URL
-t Auth token
-e Email for login
-p Password
-y Skip confirmations
-s Continue on errors (for add and remove commands)
-T Use glob pattern matching on titles (e.g., "Metrics", "JVM*")
-a Remove all dashboards
-v Show version

Advanced Examples

# Batch operations
sdm add dash1.json dash2.json -s -y      # Add multiple, skip errors
sdm rm UUID1 UUID2 -y -s                 # Remove multiple, continue on errors
sdm rm -T "*Host*|*CPU*" -y -s           # Remove by pattern, continue on errors
sdm rm -a -y                             # Remove all without confirmation

# Add dashboards
sdm add                                  # Interactive dashboard selection
sdm add https://github.com/.../dash.json # Add dashboard from URL or local file

# Pattern matching
sdm rm -T "*Performance*"                # Remove matching dashboards
sdm rm -T "Test*|Dev*"                  # Remove multiple patterns

License

MIT

About

A minimal CLI tool for managing SigNoz dashboards.

Topics

Resources

Stars

Watchers

Forks