Skip to content

README.md

Latest commit

 

History

History
172 lines (121 loc) · 13.8 KB

README.md

File metadata and controls

172 lines (121 loc) · 13.8 KB

⏰ Copilot Scheduler

VS Code Marketplace Installs License CC BY-NC-SA 4.0 GitHub GitHub Stars

Schedule automatic AI prompts with cron expressions in VS Code.

📥 Install from VS Code Marketplace

Japanese / 日本語版はこちら

🎬 Demo

Copilot Scheduler Demo

✨ Features

🗓️ Cron Scheduling - Schedule prompts to run at specific times using cron expressions

🤖 Agent & Model Selection - Choose from built-in agents (@workspace, @terminal) and AI models (GPT-4o, Claude Sonnet 4), including runtime quality or experimental quality variants when available

🌐 Multi-language Support - English and Japanese UI with auto-detection

📊 Sidebar TreeView - Manage all your scheduled tasks from the sidebar

🖥️ Webview GUI - Easy-to-use graphical interface for creating and editing tasks

⏰ Cron Expression Examples

Expression Description
0 9 * * 1-5 Weekdays at 9:00 AM
0 18 * * 1-5 Weekdays at 6:00 PM
0 9 * * * Every day at 9:00 AM
0 9 * * 1 Every Monday at 9:00 AM
*/30 * * * * Every 30 minutes
0 * * * * Every hour

📋 Commands

Command Description
Copilot Scheduler: Create Scheduled Prompt Create a new task (CLI)
Copilot Scheduler: Create Scheduled Prompt (GUI) Create a new task (GUI)
Copilot Scheduler: List Scheduled Tasks View all tasks
Copilot Scheduler: Edit Task Edit an existing task
Copilot Scheduler: Delete Task Delete a task
Copilot Scheduler: Toggle Task (Enable/Disable) Enable/disable a task
Copilot Scheduler: Enable Task Enable a task
Copilot Scheduler: Disable Task Disable a task
Copilot Scheduler: Run Now Execute a task immediately
Copilot Scheduler: Copy Prompt to Clipboard Copy prompt to clipboard
Copilot Scheduler: Duplicate Task Duplicate a task
Copilot Scheduler: Move Task to Current Workspace Move a workspace task here
Copilot Scheduler: Open Settings Open extension settings
Copilot Scheduler: Show Version Show extension version
Copilot Scheduler: Show Execution History View recent run history

⚙️ Settings

Setting Default Description
copilotScheduler.enabled true Enable/disable scheduled execution
copilotScheduler.defaultScope workspace Default scope
copilotScheduler.language auto UI language (auto/en/ja). Applies to extension Webview/Tree UI; settings-description updates may require window reload.
copilotScheduler.timezone "" Timezone for scheduling
copilotScheduler.jitterSeconds 600 Max random delay (seconds) before execution (0–1800, 0 = off). Each task can override it.
copilotScheduler.manualRunNextRunPolicy advance Next-run calculation after Run Now: advance (from existing next run) / fromNow (from current time)
copilotScheduler.chatSession new Chat session (new/continue). continue is usually faster.
copilotScheduler.autoModeDefault false Default value for new tasks' auto-mode hint (inserts an autonomous-execution instruction at the beginning of the runtime prompt).
copilotScheduler.commandDelayFactor 0.8 Delay multiplier for Copilot command sequencing (0.1–2.0). Lower is faster, but may be less stable in some environments.
copilotScheduler.showNotifications true Show notifications when tasks are executed
copilotScheduler.notificationMode sound Notification mode (sound/silentToast/silentStatus)
copilotScheduler.maxDailyExecutions 24 Daily execution limit across all tasks (0 = unlimited, 1–100). ⚠️ Unlimited may risk API rate-limiting.
copilotScheduler.minimumIntervalWarning true Warn when cron interval is shorter than 30 minutes
copilotScheduler.globalPromptsPath "" Custom global prompts folder path (default: VS Code's User/prompts folder — Windows: %APPDATA%/Code/User/prompts, macOS: ~/Library/Application Support/Code/User/prompts, Linux: $XDG_CONFIG_HOME/Code/User/prompts or ~/.config/Code/User/prompts)
copilotScheduler.globalAgentsPath "" Custom global agents folder path (*.agent.md) (default: auto-detect VS Code's User/prompts folder and ~/.copilot/agents; setting this overrides the default discovery roots)
copilotScheduler.logLevel info Log level (none/error/info/debug)
copilotScheduler.executionHistoryLimit 50 Max number of execution history entries kept for the history view (10–500)

To automatically keep AI-applied edits after review delay, configure VS Code setting chat.editing.autoAcceptDelay (0 = off, 1-100 = seconds, recommended: 5).

Task-level controls (Max Runs/Day, Allowed Time Window) are configured per task in the Webview create/edit form.

The Webview previews Copilot Chat-like thinking effort options for supported model families. If it fails, choose Default.

If execution feels sluggish when a task is triggered, try:

  • copilotScheduler.chatSession = continue
  • copilotScheduler.commandDelayFactor = 0.6 (or 0.5)
  • copilotScheduler.notificationMode = silentStatus
  • copilotScheduler.logLevel = error (or none)

📝 Prompt Placeholders

Use these placeholders in your prompts:

Placeholder Description
{{date}} Current date
{{time}} Current time
{{datetime}} Current date and time
{{workspace}} Workspace name
{{file}} Current file name
{{filepath}} Current file path

📂 Task Scope

  • Global: Task runs in all workspaces
  • Workspace: Task runs only in the specific workspace where it was created

📄 Prompt Templates

Store prompt templates for reuse:

  • Local: .github/prompts/*.md in your workspace
  • Global: VS Code user prompts folder (or the folder set in copilotScheduler.globalPromptsPath)
  • If you edit prompt text while Local/Global template source is selected (after template load completes), the task is automatically saved as Inline to keep execution consistent with the edited content.

Global custom agents are auto-discovered from the VS Code user prompts/customization folder and ~/.copilot/agents when copilotScheduler.globalAgentsPath is empty.

This follows current Copilot custom agent and Copilot CLI file locations, but this extension only discovers agent files. Prompt templates still use the VS Code user prompts folder or copilotScheduler.globalPromptsPath, not ~/.copilot/prompts, and the extension does not manage Copilot CLI sessions.

📋 Requirements

  • VS Code 1.80.0 or higher
  • GitHub Copilot extension

🛠️ Release Automation

Maintainers can publish from GitHub Actions instead of running vsce publish locally.

  • Push a tag in the form vX.Y.Z after updating package.json to the same version.
  • GitHub Actions runs npm ci, npm run compile, npm test, packages a .vsix, publishes to VS Code Marketplace, and attaches the .vsix to the GitHub release.
  • For ad-hoc publishing, use the Publish Extension workflow from the Actions tab to publish the current package.json version manually.
  • Add the repository secret VSCE_PAT before using the workflow.

⚠️ Known Issues

  • Copilot Chat API is still evolving; some features may require updates as the API stabilizes
  • Model selection may not work in all configurations
  • Experimental model quality relies on evolving VS Code/Copilot internals and may not work in all configurations

Disclaimer: This extension automates Copilot Chat. GitHub's Acceptable Use Policies prohibit "excessive automated bulk activity", the Terms of Service § H (API Terms) allow account suspension for excessive API usage, and the GitHub Copilot Additional Product Terms apply these policies directly to Copilot. Use at your own risk; your account could be rate-limited or restricted. Configure jitter/daily limits/longer intervals to reduce risk, but there is no guarantee.

Note: There are reports of Copilot access being restricted even without using automation tools. These mitigations reduce obvious automation patterns but cannot eliminate that risk.

🐛 Report a bug

📦 Release Notes

0.1.0

Initial release:

  • Cron-based task scheduling
  • Agent and model selection
  • English/Japanese localization
  • Sidebar TreeView
  • Webview GUI for task management
  • Prompt template support

📄 License

CC-BY-NC-SA-4.0 © aktsmm

Enjoy scheduling your Copilot prompts! 🚀