Getting Started
Prerequisites & CLI Setup
Install the tekanaid CLI, authenticate, and configure your environment before creating courses or labs.
Prerequisites
You should be comfortable with the following before creating content:
- •YAML syntax — all course and lab configuration is YAML
- •Markdown — task instructions and lesson transcripts are Markdown
- •Linux command line — lab setup scripts are Bash
- •Basic understanding of the technology your content covers
CLI Installation
The tekanaid CLI is the primary tool for validating and deploying courses and labs.
Once downloaded, move the binary to your PATH:
sudo mv tekanaid /usr/local/bin/
sudo chmod +x /usr/local/bin/tekanaidVerify the installation:
tekanaid versionAuthentication
Authenticate with the platform before pushing any content:
tekanaid loginIf you get an authentication error on any command, run tekanaid logout && tekanaid login to refresh your session.
Environments
Set these two variables before running any push command:
export TEKANAID_ENV=production
export TEKANAID_TARGET=povdemoQuick Reference
tekanaid loginAuthenticate with the platform
tekanaid logoutLog out of the platform
tekanaid versionPrint the CLI version number
tekanaid validate-courseValidate a course in the current directory
tekanaid push-courseDeploy a course to the platform
tekanaid validate-course-batch <dir>Validate all courses in a parent directory
tekanaid push-course-batch <dir>Deploy all courses in a parent directory
tekanaid validateValidate a lab in the current directory
tekanaid pushDeploy a lab to the platform
tekanaid validate-batch <dir>Validate all labs in a parent directory
tekanaid push-batch <dir>Deploy all labs in a parent directory
tekanaid lab-start <slug>Start a lab session for manual testing
tekanaid lab-status <slug>Get status of a running lab session
tekanaid lab-stop <slug>Stop and clean up a lab session
tekanaid test <slug>Test a lab (assignments or skips mode)
tekanaid list-labsList all available labs in your account
tekanaid list-coursesList all available courses in your account
tekanaid assets upload <path>Upload asset files for a course or lab
tekanaid assets list --course <slug>List assets uploaded for a course
