Command Line Interface (CLI)

Interact with LumiNLearn platform using our command line tool with this powerful interface for developers and educators.

Getting Started

Installation

                            
                                # macOS/Linux
                                curl -fsSL https://raw.githubusercontent.com/luminlearn/cli/main/install.sh | bash

                                # Windows (PowerShell)
                                iwr https://luminlearn.com/cli/win-installer.exe -OutFile "LuminCLI.exe"
                                .\LuminCLI.exe install

After installation, run lumin --help to verify your installation.

Quick Start

                            
                                # Add API token
                                lumin auth set --token YOUR_API_KEY

                                # Initialize project template
                                lumin init --type fastai

                                # View your learning progress
                                lumin progress dashboard

                                # Push course assignment
                                lumin submit homework3.ipynb

Command Reference

Core Commands

Command	Description
`lumin login`	Authenticate with your credentials
`lumin init`	Initialize a new project template
`lumin submit`	Submit assignments to grader system

Advanced Features

Alias	Action
`lumin p`	Pull latest project templates
`lumin ci`	Check coding exercises automatically
`lumin docs`	Open local documentation

Configuration Help

Environment Setup

Config file: ~/.lumin/config.yml


platform: lms-prod
token: YOUR_API_TOKEN
region: eu-west-1
features:
  - auto_grading
  - course_search

Environment Variables

LUMIN_API_TOKEN	Your personal API access token
LUMIN_REGION	Region for service endpoints

Common Issues

Authentication Errors

Use lumin auth renew to refresh your token when encountering 401 errors

Integration Tips

API Integration

The CLI uses API v3.2 to communicate with the LumiNLearn platform. Use LUMIN_API_VERSION environment variable to override API version if needed.