canvaslms-cli 1.4.2 → 1.4.4

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Canvas CLI Tool
+Copyright (c) 2025 Dang Duy Toan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,182 +1,106 @@
 # 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.
+A modern, user-friendly command-line interface for Canvas LMS. Manage courses, assignments, submissions, grades, 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
+- 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 Installation (Recommended)
+### Global (Recommended)
 
 ```bash
 npm install -g canvas-cli-tool
 ```
 
-### Local Installation
+### Local (Project)
 
 ```bash
 npm install canvas-cli-tool
 ```
 
+---
+
 ## Setup
 
-1. **Get your Canvas API token**:
-   - Log into your Canvas instance
+1. **Get your Canvas API Token**
+   - Log in to Canvas
    - Go to Account → Settings
-   - Scroll down to "Approved Integrations"
-   - Click "+ New Access Token"
+   - Under Approved Integrations, click + New Access Token
    - Copy the generated token
 
-2. **Configure the CLI**:
+2. **Configure the CLI**
+
    ```bash
    canvas config
    ```
 
-3. **Create a `.env` file** in your project root:
+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
-
-### 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
-```
+## Usage
 
-### Grades and Announcements
+### Common Commands
 
 ```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
+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
 ```
 
-### Raw API Access
+### Assignment Submission
 
 ```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
+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 |
-| `get` | `g` | GET API request |
-| `post` | `p` | POST API request |
-| `put` | - | PUT API request |
-| `delete` | `d` | DELETE API request |
-
-## File Structure
+| 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                |
 
-```
-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
+- Node.js >= 14.x
+- npm >= 6.x
+- Valid Canvas LMS API token
+
+---
 
 ## Contributing
 
@@ -184,10 +108,12 @@ canvas-cli-tool/
 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`
+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) file for details.
+MIT License - see [LICENSE](LICENSE) for details.