devkit

DevKit

Local Service Catalog

Run a throwaway service in one command. Credentials are generated per instance, host ports are allocated automatically, and each service exposes the same subcommands (create, list, info, logs, delete, and where applicable cli, shell, console).

• Databases: PostgreSQL, MySQL, MariaDB, MS SQL, Oracle, MongoDB, Cassandra, Redis, Elasticsearch, etcd
• Messaging: ActiveMQ, RabbitMQ, Kafka, NATS, Mosquitto
• Platform: Keycloak, Jenkins, Jupyter, Mailpit, LGTM (Grafana/Loki/Tempo/Mimir)
• Storage: MinIO, Vault, Azurite

Run devkit --help for the full list.

Create instance

$ devkit postgres create

HAPPY_MAHAVIRA (f046e1237937)

ENDPOINT        TARGET                
localhost:55095 tcp://172.17.0.5:5432

DESCRIPTION     VALUE                                                               
Database        db                                                                 
Username        postgres                                                           
Password        r02ZxXR1E5                                                         
URI             postgresql://postgres:r02ZxXR1E5@localhost:55095/db?sslmode=disable

List instances

$ devkit postgres list

happy_mahavira

Display info

$ devkit postgres info
> happy_mahavira

HAPPY_MAHAVIRA (f046e1237937)

ENDPOINT        TARGET                
localhost:55095 tcp://172.17.0.5:5432

DESCRIPTION     VALUE                                                               
Database        db                                                                 
Username        postgres                                                           
Password        r02ZxXR1E5                                                         
URI             postgresql://postgres:r02ZxXR1E5@localhost:55095/db?sslmode=disable

Follow logs

$ devkit postgres logs
> happy_mahavira

2024-07-14 12:09:29.661 UTC [1] LOG:  database system is ready to accept connections

Start connected client

$ devkit postgres cli
> happy_mahavira

psql (16.3 (Debian 16.3-1.pgdg120+1))
Type "help" for help.

db=#

Open shell

$ devkit postgres shell
> happy_mahavira

root@f046e1237937:/#

Delete instance

$ devkit postgres delete
> happy_mahavira

Analze Repository

Static Analysis (using Semgrep)

$ devkit sast

Vulnerability Scanning (using Trivy)

$ devkit scan

Lines of Code (using cloc)

$ devkit cloc

List big blobs

$ devkit git blobs

Find leaks (using Gitleaks)

$ devkit git leaks

Delete file in history

Rewrites every commit and force-pushes the result to origin. This cannot be undone, so the command asks for confirmation first.

$ devkit git purge /path/to/file1 /path/to/file2

Analyze Images

Inspect (using Whaler)

$ devkit image inspect --image ubuntu

Dockerfile Linting (using Dockle)

$ devkit image lint --image ubuntu

Vulnerability Scanning (using Trivy)

$ devkit image scan --image ubuntu

Show Bill of Material (using Syft)

$ devkit image bom --image ubuntu

TUI Browser (using Dive)

$ devkit image browse --image ubuntu

Utilities

Local Web IDE

$ devkit code
> default

NAME    VALUE                 
URL     http://localhost:3000

Forward /Users/User/Projects to /workspace

Local Web Server

Simple File Server with CORS and optional SPA support

$ devkit server [--port 3000] [--spa] [--index index.html]

Local Proxy

Test your application for proxy support

$ devkit proxy [--port 3128] [--user username] [--password password]

Install

Requirements

• Running Docker, Podman, Rancher or Lima VM

MacOS / Linux

Homebrew

brew install adrianliechti/tap/devkit

Windows

Scoop

scoop bucket add adrianliechti https://github.com/adrianliechti/scoop-bucket
scoop install adrianliechti/devkit