Developer Guides/Andamio CLI
Overview
Manage Andamio courses, modules, and content from the command line
Andamio CLI
The Andamio CLI is a command-line tool for managing course content and project tasks. Export modules for local editing, create on-chain task bounties linked to GitHub issues, import changes, and manage authentication — all without leaving your terminal.
What You Can Do
Browse and Query
| Task | Command |
|---|---|
| See your dashboard | andamio user me |
| List your courses | andamio course list |
| List project tasks (public) | andamio project tasks <project-id> |
| Check if a user exists | andamio user exists <alias> |
| Browse API endpoints | andamio spec paths |
Authentication
| Task | Command |
|---|---|
| Authenticate (browser) | andamio user login |
| Authenticate (headless/CI) | andamio user login --skey ./payment.skey --alias myalias |
| Check auth status | andamio user status |
Course Owner and Teacher
| Task | Command |
|---|---|
| List courses you own | andamio course owner list |
| Create a course | andamio course owner create --title "My Course" |
| List courses you teach | andamio teacher courses |
| Export a module for editing | andamio course export <course-id> <module-code> or --course "Name" |
| Import updated content | andamio course import ./compiled/101 --course-id <id> or --course "Name" |
| Import all modules at once | andamio course import-all ./compiled/my-course --course-id <id> |
| Create a new module | andamio course create-module --course-id <id> --code 101 --title "My Module" |
| Register a module from chain | andamio course teacher register-module --course-id <id> --module-code 101 |
| Publish a module | andamio course teacher publish-module --course-id <id> --module-code 101 |
| Review a student submission | andamio course teacher review --course-id <id> --commitment-id <cid> --decision approve |
| List pending reviews | andamio course teacher commitments --course-id <id> |
Course Student
| Task | Command |
|---|---|
| List enrolled courses | andamio course student courses |
| Enroll in a module | andamio course student create --course-id <id> --module-code 101 |
| Submit assignment evidence | andamio course student submit --course-id <id> --module-code 101 --evidence "https://..." |
| List your credentials | andamio course student credentials |
| Claim a credential | andamio course student claim --course-id <id> --module-code 101 |
Project Owner and Manager
| Task | Command |
|---|---|
| List projects you own | andamio project owner list |
| Create a project | andamio project owner create --title "My Project" |
| List tasks (manager) | andamio project task list <project-id> |
| Create a task with token rewards | andamio project task create <project-id> --title "..." --lovelace 5000000 --expiration 2026-06-01 --token "policyid,XP,50" |
| Link a task to a GitHub issue | andamio project task create <project-id> --title "..." --github-issue org/repo#42 --lovelace 5000000 --expiration 2026-06-01 |
| Export tasks to Markdown | andamio project task export <project-id> |
| List pending assessments | andamio project manager commitments --project-id <id> |
Project Contributor
| Task | Command |
|---|---|
| List projects you contribute to | andamio project contributor list |
| Commit to a task | andamio project contributor commit --project-id <id> --task-index 3 |
| Submit evidence | andamio project contributor update --project-id <id> --task-index 3 --evidence "https://..." |
| List your commitments | andamio project contributor commitments |
| Verify task hashes | andamio project task verify-hash <project-id> |
Transactions
| Task | Command |
|---|---|
| Full transaction lifecycle | andamio tx run /v2/tx/... --body '...' --skey ./key.skey --tx-type ... |
| Sign and submit (step by step) | andamio tx build → tx sign → tx submit → tx register |
Quick Start
# Install
go install github.com/Andamio-Platform/andamio-cli/cmd/andamio@latest
# Configure
andamio auth login --api-key YOUR_KEY
andamio user login
# List courses
andamio course list
# Export a module, edit locally, re-import
andamio course export <course-id> 101
vim compiled/my-course/101/lesson-1.md
andamio course import compiled/my-course/101 --course-id <course-id>Guides
| Guide | Description |
|---|---|
| Installation | Install the CLI and verify setup |
| Authentication | API keys, wallet login, JWT management |
| Managing Courses | Query courses, teacher module management, student enrollment and credentials |
| Import & Export | Round-trip course editing workflow |
| Import Format | File format reference for outline.md, lesson-N.md, etc. |
| Managing Tasks | Task bounties, contributor workflows, manager reviews |
| Task Import & Export | Edit tasks as Markdown files and sync changes |
| Transaction Signing | Sign and submit Cardano transactions with a local .skey file |
Source
The CLI is open source: github.com/Andamio-Platform/andamio-cli