UNPKG

canvaslms-cli

Version:

A command line tool for interacting with Canvas LMS API

github.com/caphefalumi/Canvas-CLI

caphefalumi/Canvas-CLI

120 lines (84 loc) • 2.96 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# Canvas CLI Tool A modern, user-friendly command-line interface for Canvas LMS. Manage courses, assignments, submissions, grades, and more directly from your terminal. --- ## Features - List and filter enrolled/starred courses - View assignments, grades, and submission status - Interactive file upload for assignments - View course announcements - Display user profile information - Direct access to Canvas API endpoints --- ## Installation ### Global (Recommended) ```bash npm install -g canvas-cli-tool ``` ### Local (Project) ```bash npm install canvas-cli-tool ``` --- ## Setup 1. **Get your Canvas API Token** - Log in to Canvas - Go to Account → Settings - Under Approved Integrations, click + New Access Token - Copy the generated token 2. **Configure the CLI** ```bash canvas config ``` 3. **Environment Variables** Create a `.env` file in your project root: ```env CANVAS_DOMAIN=your-canvas-domain.instructure.com CANVAS_API_TOKEN=your-api-token ``` --- ## Usage ### Common Commands ```bash canvas config # Configure domain and API token canvas list # List starred courses canvas list -a # List all enrolled courses canvas assignments <course> # List assignments for a course canvas grades # Show grades for all courses canvas announcements # Show recent announcements canvas profile # Show user profile canvas submit # Interactive assignment submission ``` ### Assignment Submission ```bash canvas submit # Interactive mode canvas submit -c <courseId> # Specify course canvas submit -a <assignmentId> # Specify assignment canvas submit -f <file> # Submit specific file ``` ## Command Reference | Command | Alias | Description | |-----------------|-----------|-----------------------------------| | `list` | `l` | List courses | | `assignments` | `assign` | List assignments | | `submit` | `sub` | Submit assignment files | | `grades` | `grade` | Show grades | | `announcements` | `announce`| Show announcements | | `profile` | `me` | Show user profile | | `config` | - | Show configuration | --- ## Requirements - Node.js >= 14.x - npm >= 6.x - Valid Canvas LMS API token --- ## Contributing 1. Fork the repository 2. Create a feature branch: `git checkout -b feature-name` 3. Make your changes 4. Run tests: `npm test` 5. Commit: `git commit -am 'Add feature'` 6. Push: `git push origin feature-name` 7. Submit a pull request --- ## License MIT License - see [LICENSE](LICENSE) for details.