Skip to main content

Dzaleka Digital Heritage CLI

A comprehensive command-line tool for accessing and managing digital resources from Dzaleka Refugee Camp’s heritage platform

Get startedCommand reference

Quick start

Get up and running with DZDK CLI in minutes

1

Install the CLI

Clone the repository and install dependencies:
git clone https://github.com/Dzaleka-Connect/dzdk-cli.git
cd dzdk-cli
python3 -m venv venv
source venv/bin/activate
pip install -e .
2

Configure the API endpoint

Set your API URL and timeout preferences:
dzdk config --url "https://services.dzaleka.com/api" --timeout 30
Configuration is stored in ~/.config/dzdk/config.yaml
3

Check API health

Verify your connection to the API:
dzdk health
This command checks all endpoints and displays response times and status codes.
4

List available services

Browse services in the Dzaleka camp:
dzdk services list --page 1
You’ll see a formatted table with service details, categories, and contact information.

Explore by feature

Discover what you can do with DZDK CLI

Services

Browse and search services available in Dzaleka camp with filtering and pagination

Events

List upcoming and past events with detailed information and registration details

Photos

Upload, manage, and organize photos in albums with metadata and tagging

Population

Access demographic data, population trends, and statistical information

Resources

Download documents, reports, and digital resources from the library

Search

Search across all content types with filtering and relevance sorting

Advanced capabilities

Power features for efficient workflows

Batch operations

Upload or download multiple files in parallel with progress tracking

Data export

Export data to CSV or generate detailed markdown reports

Interactive shell

Use the built-in shell with history, completion, and command suggestions

Ready to get started?

Install DZDK CLI and start exploring the Dzaleka Digital Heritage platform

Install now