canvaslms-cli 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,83 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.1.0] - 2025-07-03
+
+### Added
+
+- Home directory configuration system (~/.canvaslms-cli-config.json)
+- Interactive configuration setup wizard (`canvas config setup`)
+- Configuration management subcommands:
+  - `canvas config show` - Display current configuration
+  - `canvas config edit` - Edit existing configuration
+  - `canvas config path` - Show config file location
+  - `canvas config delete` - Remove configuration file
+- Automatic configuration validation for all commands
+- Improved error handling and user guidance
+
+### Changed
+
+- **BREAKING**: Removed environment variable support (.env files)
+- Configuration now stored in user's home directory instead of project directory
+- Enhanced configuration validation with better error messages
+- Improved user onboarding with guided setup process
+
+### Removed
+
+- dotenv dependency (no longer needed)
+- Environment variable fallback support
+
+## [1.0.0] - 2025-07-03
+
+### Added
+
+- Initial release of Canvas CLI Tool
+- Modular architecture with separate command handlers
+- Interactive assignment submission with file upload
+- Course management (list starred/all courses)
+- Assignment operations (view, filter by status)
+- Grade viewing for all courses or specific course
+- Announcements viewing
+- User profile management
+- Raw API access for all HTTP methods (GET, POST, PUT, DELETE)
+- Comprehensive configuration management
+- Color-coded output for better readability
+- Support for multiple file uploads
+- File selection from current directory
+- Detailed verbose modes for all commands
+
+### Features
+
+- 📚 Course listing with favorites support
+- 📝 Assignment management with status indicators
+- 🚀 Interactive file submission workflow
+- 📢 Announcement viewing
+- 👤 Profile information display
+- 🔧 Direct Canvas API access
+- ⚡ Command aliases for faster usage
+- 🎨 Color-coded grade display
+- 📁 Smart file selection interface
+
+### Technical
+
+- Modular command structure in separate files
+- Reusable API client library
+- Interactive prompt utilities
+- File upload handling with progress indicators
+- Error handling and user-friendly messages
+- Cross-platform compatibility
+
+## [Unreleased]
+
+### Planned Features
+
+- Assignment creation and editing
+- Bulk operations
+- Plugin system
+- Advanced filtering options
+- Export functionality
+- Offline mode support

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Canvas CLI Tool
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,193 @@
+# Canvas CLI Tool
+
+A powerful command-line interface for interacting with Canvas LMS API. This tool allows you to manage courses, assignments, submissions, and more directly from your terminal.
+
+## Features
+
+- 📚 **Course Management**: List starred and enrolled courses
+- 📝 **Assignment Operations**: View assignments, grades, and submission status
+- 🚀 **File Submission**: Interactive file upload for assignments (single or multiple files)
+- 📢 **Announcements**: View course announcements
+- 👤 **Profile Management**: View user profile information
+- 🔧 **Raw API Access**: Direct access to Canvas API endpoints
+
+## Installation
+
+### Global Installation (Recommended)
+
+```bash
+npm install -g canvas-cli-tool
+```
+
+### Local Installation
+
+```bash
+npm install canvas-cli-tool
+```
+
+## Setup
+
+1. **Get your Canvas API token**:
+   - Log into your Canvas instance
+   - Go to Account → Settings
+   - Scroll down to "Approved Integrations"
+   - Click "+ New Access Token"
+   - Copy the generated token
+
+2. **Configure the CLI**:
+   ```bash
+   canvas config
+   ```
+
+3. **Create a `.env` file** in your project root:
+   ```env
+   CANVAS_DOMAIN=your-canvas-domain.instructure.com
+   CANVAS_API_TOKEN=your-api-token
+   ```
+
+## Usage
+
+### Basic Commands
+
+```bash
+# Show configuration help
+canvas config
+
+# List starred courses (default)
+canvas list
+
+# List all enrolled courses
+canvas list -a
+
+# List courses with detailed information
+canvas list -v
+
+# Show user profile
+canvas profile
+
+# Show detailed profile information
+canvas profile -v
+```
+
+### Assignment Operations
+
+```bash
+# List assignments for a course
+canvas assignments 12345
+
+# Show detailed assignment information
+canvas assignments 12345 -v
+
+# Show only submitted assignments
+canvas assignments 12345 -s
+
+# Show only pending assignments
+canvas assignments 12345 -p
+```
+
+### File Submission
+
+```bash
+# Interactive assignment submission
+canvas submit
+
+# Submit with specific course ID
+canvas submit -c 12345
+
+# Submit with specific assignment ID
+canvas submit -a 67890
+
+# Submit specific file
+canvas submit -f myfile.pdf
+```
+
+### Grades and Announcements
+
+```bash
+# Show grades for all courses
+canvas grades
+
+# Show grades for specific course
+canvas grades 12345
+
+# Show recent announcements
+canvas announcements
+
+# Show announcements for specific course
+canvas announcements 12345
+```
+
+### Raw API Access
+
+```bash
+# GET request
+canvas get users/self
+
+# GET with query parameters
+canvas get courses -q enrollment_state=active
+
+# POST request with data
+canvas post courses/123/assignments -d '{"assignment": {"name": "Test"}}'
+
+# POST with data from file
+canvas post courses/123/assignments -d @assignment.json
+```
+
+## 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 |
+| `get` | `g` | GET API request |
+| `post` | `p` | POST API request |
+| `put` | - | PUT API request |
+| `delete` | `d` | DELETE API request |
+
+## File Structure
+
+```
+canvas-cli-tool/
+├── src/
+│   └── index.js          # Main CLI entry point
+├── lib/
+│   ├── api-client.js     # Canvas API client
+│   ├── config.js         # Configuration management
+│   ├── file-upload.js    # File upload utilities
+│   └── interactive.js    # Interactive prompt utilities
+├── commands/
+│   ├── list.js           # List courses command
+│   ├── assignments.js    # Assignments command
+│   ├── submit.js         # Submit command
+│   ├── grades.js         # Grades command
+│   ├── announcements.js  # Announcements command
+│   ├── profile.js        # Profile command
+│   ├── config.js         # Config command
+│   └── api.js            # Raw API commands
+└── package.json
+```
+
+## Requirements
+
+- Node.js >= 14.0.0
+- npm >= 6.0.0
+- Valid Canvas LMS access with 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 your changes: `git commit -am 'Add feature'`
+6. Push to the branch: `git push origin feature-name`
+7. Submit a pull request
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.

package/commands/announcements.js

@@ -0,0 +1,77 @@
+/**
+ * Announcements command
+ */
+
+const { makeCanvasRequest } = require('../lib/api-client');
+
+async function showAnnouncements(courseId, options) {
+  try {
+    if (courseId) {
+      // Get announcements for specific course
+      const announcements = await makeCanvasRequest('get', `courses/${courseId}/discussion_topics`, [
+        'only_announcements=true',
+        `per_page=${options.limit}`
+      ]);
+      
+      if (!announcements || announcements.length === 0) {
+        console.log('No announcements found for this course.');
+        return;
+      }
+      
+      console.log(`Recent ${announcements.length} announcement(s) for course ${courseId}:\n`);
+      
+      announcements.forEach((announcement, index) => {
+        console.log(`${index + 1}. ${announcement.title}`);
+        console.log(`   Posted: ${announcement.posted_at ? new Date(announcement.posted_at).toLocaleString() : 'N/A'}`);
+        console.log(`   Author: ${announcement.author?.display_name || 'Unknown'}`);
+        
+        if (announcement.message) {
+          // Remove HTML tags and truncate
+          const message = announcement.message.replace(/<[^>]*>/g, '').substring(0, 200);
+          console.log(`   Message: ${message}${announcement.message.length > 200 ? '...' : ''}`);
+        }
+        
+        console.log('');
+      });
+      
+    } else {
+      // Get announcements for all enrolled courses
+      const courses = await makeCanvasRequest('get', 'courses', ['enrollment_state=active']);
+      
+      if (!courses || courses.length === 0) {
+        console.log('No courses found.');
+        return;
+      }
+      
+      console.log('Getting announcements from all enrolled courses...\n');
+      
+      for (const course of courses.slice(0, 3)) { // Limit to first 3 courses to avoid too many requests
+        try {
+          const announcements = await makeCanvasRequest('get', `courses/${course.id}/discussion_topics`, [
+            'only_announcements=true',
+            'per_page=2'
+          ]);
+          
+          if (announcements && announcements.length > 0) {
+            console.log(`📢 ${course.name}:`);
+            announcements.forEach((announcement) => {
+              console.log(`  • ${announcement.title} (${announcement.posted_at ? new Date(announcement.posted_at).toLocaleDateString() : 'No date'})`);
+            });
+            console.log('');
+          }
+        } catch (error) {
+          // Skip courses that don't allow access to announcements
+          continue;
+        }
+      }
+    }
+    
+  } catch (error) {
+    console.error('Error fetching announcements:', error.message);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  showAnnouncements
+};

package/commands/api.js

@@ -0,0 +1,19 @@
+/**
+ * Raw API commands (get, post, put, delete, query)
+ */
+
+const { makeCanvasRequest } = require('../lib/api-client');
+
+/**
+ * Create query command handler
+ */
+function createQueryHandler(method) {
+  return async function(endpoint, options) {
+    const data = await makeCanvasRequest(method, endpoint, options.query, options.data);
+    console.log(JSON.stringify(data, null, 2));
+  };
+}
+
+module.exports = {
+  createQueryHandler
+};

package/commands/assignments.js

@@ -0,0 +1,126 @@
+/**
+ * Assignments command
+ */
+
+const { makeCanvasRequest } = require('../lib/api-client');
+
+async function listAssignments(courseId, options) {
+  try {
+    const queryParams = ['include[]=submission', 'include[]=score_statistics', 'per_page=100'];
+    
+    const assignments = await makeCanvasRequest('get', `courses/${courseId}/assignments`, queryParams);
+    
+    if (!assignments || assignments.length === 0) {
+      console.log('No assignments found for this course.');
+      return;
+    }
+    
+    // Filter assignments based on options
+    let filteredAssignments = assignments;
+    if (options.submitted) {
+      filteredAssignments = assignments.filter(a => a.submission && a.submission.submitted_at);
+    } else if (options.pending) {
+      filteredAssignments = assignments.filter(a => !a.submission || !a.submission.submitted_at);
+    }
+    
+    console.log(`Found ${filteredAssignments.length} assignment(s):\n`);
+    
+    filteredAssignments.forEach((assignment, index) => {
+      const submission = assignment.submission;
+      const isSubmitted = submission && submission.submitted_at;
+      const submissionStatus = isSubmitted ? '✅' : '❌';
+      
+      // Format grade like Canvas web interface with enhanced formatting
+      let gradeDisplay = '';
+      let gradeColor = '';
+      
+      if (submission && submission.score !== null && submission.score !== undefined) {
+        // Format score to remove unnecessary decimals (e.g., 3.0 becomes 3)
+        const score = submission.score % 1 === 0 ? Math.round(submission.score) : submission.score;
+        const total = assignment.points_possible || 0;
+        gradeDisplay = `${score}/${total}`;
+        
+        // Add color coding based on score percentage
+        if (total > 0) {
+          const percentage = (submission.score / total) * 100;
+          if (percentage >= 90) gradeColor = '\x1b[32m'; // Green for A
+          else if (percentage >= 80) gradeColor = '\x1b[36m'; // Cyan for B  
+          else if (percentage >= 70) gradeColor = '\x1b[33m'; // Yellow for C
+          else if (percentage >= 60) gradeColor = '\x1b[35m'; // Magenta for D
+          else gradeColor = '\x1b[31m'; // Red for F
+        }
+      } else if (submission && submission.excused) {
+        gradeDisplay = 'Excused';
+        gradeColor = '\x1b[34m'; // Blue for excused
+      } else if (submission && submission.missing) {
+        gradeDisplay = 'Missing';
+        gradeColor = '\x1b[31m'; // Red for missing
+      } else if (assignment.points_possible) {
+        gradeDisplay = `–/${assignment.points_possible}`;
+        gradeColor = '\x1b[90m'; // Gray for not graded yet
+      } else {
+        gradeDisplay = 'N/A';
+        gradeColor = '\x1b[90m'; // Gray for N/A
+      }
+      
+      // Handle letter grades if present
+      if (submission && submission.grade && isNaN(submission.grade)) {
+        gradeDisplay = submission.grade + (assignment.points_possible ? ` (${gradeDisplay})` : '');
+      }
+      
+      console.log(`${index + 1}. ${submissionStatus} ${assignment.name}`);
+      console.log(`   ID: ${assignment.id}`);
+      console.log(`   Grade: ${gradeColor}${gradeDisplay} pts\x1b[0m`);
+      console.log(`   Due: ${assignment.due_at ? new Date(assignment.due_at).toLocaleString() : 'No due date'}`);
+      
+      if (isSubmitted) {
+        console.log(`   Submitted: ${new Date(submission.submitted_at).toLocaleString()}`);
+        if (submission.workflow_state) {
+          // Color code submission status
+          let statusColor = '';
+          switch(submission.workflow_state) {
+            case 'graded': statusColor = '\x1b[32m'; break; // Green
+            case 'submitted': statusColor = '\x1b[33m'; break; // Yellow
+            case 'pending_review': statusColor = '\x1b[36m'; break; // Cyan
+            default: statusColor = '\x1b[37m'; // White
+          }
+          console.log(`   Status: ${statusColor}${submission.workflow_state}\x1b[0m`);
+        }
+      } else {
+        console.log(`   Status: \x1b[31mNot submitted\x1b[0m`); // Red for not submitted
+      }
+      
+      if (options.verbose) {
+        if (assignment.description) {
+          // Strip HTML tags and clean up description
+          const cleanDescription = assignment.description
+            .replace(/<[^>]*>/g, '') // Remove HTML tags
+            .replace(/\s+/g, ' ')    // Replace multiple whitespace with single space
+            .trim()                  // Remove leading/trailing whitespace
+            .substring(0, 150);      // Limit to 150 characters
+          console.log(`   Description: ${cleanDescription}${cleanDescription.length === 150 ? '...' : ''}`);
+        } else {
+          console.log(`   Description: N/A`);
+        }
+        console.log(`   Submission Types: ${assignment.submission_types?.join(', ') || 'N/A'}`);
+        console.log(`   Published: ${assignment.published ? 'Yes' : 'No'}`);
+        if (assignment.points_possible) {
+          console.log(`   Points Possible: ${assignment.points_possible}`);
+        }
+        if (submission && submission.attempt) {
+          console.log(`   Attempt: ${submission.attempt}`);
+        }
+      }
+      
+      console.log('');
+    });
+    
+  } catch (error) {
+    console.error('Error fetching assignments:', error.message);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  listAssignments
+};