@lppx/taskmgr 0.0.0 → 0.1.0

package/README.md

@@ -1,48 +1,33 @@
-@lppx/taskmgr
-=================
-
-定时任务管理器
-
-
-[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/@lppx/taskmgr.svg)](https://npmjs.org/package/@lppx/taskmgr)
-[![Downloads/week](https://img.shields.io/npm/dw/@lppx/taskmgr.svg)](https://npmjs.org/package/@lppx/taskmgr)
-
-
+@lppx/taskmgr
+=================
+
+定时任务管理器
+
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/@lppx/taskmgr.svg)](https://npmjs.org/package/@lppx/taskmgr)
+[![Downloads/week](https://img.shields.io/npm/dw/@lppx/taskmgr.svg)](https://npmjs.org/package/@lppx/taskmgr)
+
+
 <!-- toc -->
 * [Usage](#usage)
 * [Commands](#commands)
-<!-- tocstop -->
-* [Usage](#usage)
-* [Commands](#commands)
-<!-- tocstop -->
-# Usage
+<!-- tocstop -->
+# Usage
 <!-- usage -->
 ```sh-session
 $ npm install -g @lppx/taskmgr
 $ tm COMMAND
 running command...
 $ tm (--version)
-@lppx/taskmgr/0.0.0 win32-x64 node-v24.11.0
+@lppx/taskmgr/0.1.0 linux-x64 node-v24.14.0
 $ tm --help [COMMAND]
 USAGE
   $ tm COMMAND
 ...
 ```
-<!-- usagestop -->
-```sh-session
-$ npm install -g @lppx/taskmgr
-$ tm COMMAND
-running command...
-$ tm (--version)
-@lppx/taskmgr/0.0.0 linux-x64 node-v20.20.1
-$ tm --help [COMMAND]
-USAGE
-  $ tm COMMAND
-...
-```
-<!-- usagestop -->
-# Commands
+<!-- usagestop -->
+# Commands
 <!-- commands -->
 * [`tm autocomplete [SHELL]`](#tm-autocomplete-shell)
 * [`tm help [COMMAND]`](#tm-help-command)
@@ -123,7 +108,7 @@ EXAMPLES
   $ tm scripts add ./script.ps1
 ```
 
-_See code: [src/commands/scripts/add.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.0.0/src/commands/scripts/add.ts)_
+_See code: [src/commands/scripts/add.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.1.0/src/commands/scripts/add.ts)_
 
 ## `tm scripts list`
 
@@ -140,7 +125,7 @@ EXAMPLES
   $ tm scripts list
 ```
 
-_See code: [src/commands/scripts/list.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.0.0/src/commands/scripts/list.ts)_
+_See code: [src/commands/scripts/list.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.1.0/src/commands/scripts/list.ts)_
 
 ## `tm scripts open`
 
@@ -157,7 +142,7 @@ EXAMPLES
   $ tm scripts open
 ```
 
-_See code: [src/commands/scripts/open.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.0.0/src/commands/scripts/open.ts)_
+_See code: [src/commands/scripts/open.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.1.0/src/commands/scripts/open.ts)_
 
 ## `tm tsk add TASKNAME`
 
@@ -165,24 +150,25 @@ _See code: [src/commands/scripts/open.ts](https://github.com/lipanpan-hub/taskmg
 
 ```
 USAGE
-  $ tm tsk add TASKNAME --path <value> [--arguments <value>] [--description <value>] [--hidden]
-    [--start-when-available] [--stop-on-battery] [--time <value>] [--trigger boot|daily|logon|monthly|once|weekly]
-    [--wake]
+  $ tm tsk add TASKNAME [-p <value> |  | [--arguments <value> --path <value>]] [--description <value>]
+    [--hidden] [--start-when-available] [--stop-on-battery] [--time <value>] [--trigger
+    boot|daily|logon|monthly|once|weekly] [--wake]
 
 ARGUMENTS
   TASKNAME  任务名称
 
 FLAGS
-  --arguments=<value>     执行参数
-  --description=<value>   任务描述
-  --hidden                是否隐藏任务
-  --path=<value>          (required) 可执行文件路径
-  --start-when-available  错过启动时间后是否自动启动
-  --stop-on-battery       使用电池供电时是否停止任务
-  --time=<value>          [default: 09:00] 任务开始时间 (HH:mm)
-  --trigger=<option>      [default: daily] 触发类型: daily, weekly, monthly, once, boot, logon
-                          <options: boot|daily|logon|monthly|once|weekly>
-  --wake                  是否唤醒计算机运行任务
+  -p, --ps-script=<value>          PowerShell 脚本路径，自动使用 powershell.exe 执行
+      --arguments=<value>          执行参数
+      --description=<value>        任务描述
+      --[no-]hidden                是否隐藏任务
+      --path=<value>               可执行文件路径
+      --[no-]start-when-available  错过启动时间后是否自动启动
+      --[no-]stop-on-battery       使用电池供电时是否停止任务
+      --time=<value>               [default: 09:00] 任务开始时间 (HH:mm)
+      --trigger=<option>           [default: daily] 触发类型: daily, weekly, monthly, once, boot, logon
+                                   <options: boot|daily|logon|monthly|once|weekly>
+      --[no-]wake                  是否唤醒计算机运行任务
 
 DESCRIPTION
   创建定时任务
@@ -197,9 +183,11 @@ EXAMPLES
   $ tm tsk add psTask --path "powershell.exe" --arguments '-ExecutionPolicy Bypass -File "C:\scripts\cleanup.ps1"' --trigger daily
 
   $ tm tsk add psInlineTask --path "powershell.exe" --arguments '-Command "Get-ChildItem C:\temp | Remove-Item -Recurse -Force"' --trigger weekly
+
+  $ tm tsk add scriptTask --ps-script "C:\scripts\cleanup.ps1" --trigger daily
 ```
 
-_See code: [src/commands/tsk/add.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.0.0/src/commands/tsk/add.ts)_
+_See code: [src/commands/tsk/add.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.1.0/src/commands/tsk/add.ts)_
 
 ## `tm tsk del TASKNAME`
 
@@ -219,7 +207,7 @@ EXAMPLES
   $ tm tsk del myTask
 ```
 
-_See code: [src/commands/tsk/del.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.0.0/src/commands/tsk/del.ts)_
+_See code: [src/commands/tsk/del.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.1.0/src/commands/tsk/del.ts)_
 
 ## `tm tsk list`
 
@@ -230,7 +218,7 @@ USAGE
   $ tm tsk list [--multi]
 
 FLAGS
-  --multi  使用多行格式显示任务详情
+  --[no-]multi  使用多行格式显示任务详情
 
 DESCRIPTION
   列出所有定时任务
@@ -241,7 +229,7 @@ EXAMPLES
   $ tm tsk list --multi
 ```
 
-_See code: [src/commands/tsk/list.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.0.0/src/commands/tsk/list.ts)_
+_See code: [src/commands/tsk/list.ts](https://github.com/lipanpan-hub/taskmgr/blob/v0.1.0/src/commands/tsk/list.ts)_
 
 ## `tm version`
 
@@ -262,79 +250,4 @@ FLAG DESCRIPTIONS
 ```
 
 _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.37/src/commands/version.ts)_
-<!-- commandsstop -->
-* [`tm autocomplete [SHELL]`](#tm-autocomplete-shell)
-* [`tm help [COMMAND]`](#tm-help-command)
-* [`tm version`](#tm-version)
-
-## `tm autocomplete [SHELL]`
-
-Display autocomplete installation instructions.
-
-```
-USAGE
-  $ tm autocomplete [SHELL] [-r]
-
-ARGUMENTS
-  [SHELL]  (zsh|bash|powershell) Shell type
-
-FLAGS
-  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
-
-DESCRIPTION
-  Display autocomplete installation instructions.
-
-EXAMPLES
-  $ tm autocomplete
-
-  $ tm autocomplete bash
-
-  $ tm autocomplete zsh
-
-  $ tm autocomplete powershell
-
-  $ tm autocomplete --refresh-cache
-```
-
-_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.40/src/commands/autocomplete/index.ts)_
-
-## `tm help [COMMAND]`
-
-Display help for tm.
-
-```
-USAGE
-  $ tm help [COMMAND...] [-n]
-
-ARGUMENTS
-  [COMMAND...]  Command to show help for.
-
-FLAGS
-  -n, --nested-commands  Include all nested commands in the output.
-
-DESCRIPTION
-  Display help for tm.
-```
-
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.37/src/commands/help.ts)_
-
-## `tm version`
-
-```
-USAGE
-  $ tm version [--json] [--verbose]
-
-FLAGS
-  --verbose  Show additional information about the CLI.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-FLAG DESCRIPTIONS
-  --verbose  Show additional information about the CLI.
-
-    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
-```
-
-_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.37/src/commands/version.ts)_
 <!-- commandsstop -->

package/TaskScheduler.2.12.2/TaskService.md

@@ -1,72 +1,72 @@
-## About
-The original and most popular .NET wrapper for the [Windows Task Scheduler](https://docs.microsoft.com/en-us/windows/win32/taskschd/task-scheduler-start-page). It provides functionally complete classes that cover all development aspects related to system tasks.
-
-More information can be found on the [project page on GitHub](https://github.com/dahall/taskscheduler).
-
-## Support
-Below are links to sites that provide in-depth examples, documentation and discussions. Please go here first with your questions as the community has been active for over a decade.
-* [Wiki](https://github.com/dahall/TaskScheduler/wiki) - Sample code, library how-to, troubleshooting, etc.
-* [API documentation](https://dahall.github.io/TaskScheduler) - Class/method/property documentation and examples
-* [Full Issues Log](https://github.com/dahall/TaskScheduler/issues?q=) - Use the search box to see if your question may already be answered.
-* [Discussion Forum](https://github.com/dahall/TaskScheduler/discussions) - Users helping users, enhancement requests, Q&A (retired Google forum [here](https://groups.google.com/forum/#!forum/taskscheduler))
-* [Troubleshooting Tool](https://github.com/dahall/TaskSchedulerConfig) - Tool to help identify and fix configuration and connectivity issues. (ClickOnce installer [here](https://github.com/dahall/TaskSchedulerConfig/blob/master/publish/setup.exe?raw=true))
-
-## Key Features
-Microsoft introduced version 2.0 (internally version 1.2) with a completely new object model with Windows Vista. The managed assembly closely resembles the new object model but allows the 1.0 (internally version 1.1) COM objects to be manipulated. It will automatically choose the most recent version of the library found on the host system (up through 1.4). Core features include:
-
-* Separate, functionally identical, libraries for .NET 2.0, 3.5, 4.0, 4.52, 5.0, 6.0, .NET Standard 2.0, .NET Core 2.0, 2.1, 3.0, 3.1.
-* Unlike the base COM libraries, this wrapper accommodates creating and viewing tasks up and down stream.
-* Supports all V2 native properties, even under V1 tasks.
-* Maintain EmailAction and ShowMessageAction using PowerShell scripts for systems after Win8 where these actions have been deprecated.
-* Supports all action types (not just ExecAction) on V1 systems (XP/WS2003) and earlier (if PowerShell is installed).
-* Supports multiple actions on V1 systems (XP/WS2003). Native library only supports a single action.
-* Supports serialization to XML for both 1.0 and 2.0 tasks (base library only supports 2.0)
-* Supports task validation for targeted version.
-* Supports secure task reading and maintenance.
-* Fluent methods for task creation.
-* Cron syntax for trigger creation.
-
-The currently supported localizations include: English, Spanish, Italian, French, Chinese (Simplified), German, Polish and Russian.
-
-## Usage
-You can perform several actions in a single line of code:  
-```C#
-// Run a program every day on the local machine
-TaskService.Instance.AddTask("Test", QuickTriggerType.Daily, "myprogram.exe", "-a arg");
-
-// Run a custom COM handler on the last day of every month
-TaskService.Instance.AddTask("Test", new MonthlyTrigger { RunOnLastDayOfMonth = true }, 
-    new ComHandlerAction(new Guid("{CE7D4428-8A77-4c5d-8A13-5CAB5D1EC734}")));
-```
-
-For many more options, use the library classes to build a complex task. Below is a brief example of how to use the library from C#.  
-```C#
-using System;
-using Microsoft.Win32.TaskScheduler;
-
-class Program
-{
-   static void Main()
-   {
-      // Get the service on the remote machine
-      using (TaskService ts = new TaskService(@"\\RemoteServer", "username", "domain", "password"))
-      {
-         // Create a new task definition and assign properties
-         TaskDefinition td = ts.NewTask();
-         td.RegistrationInfo.Description = "Does something";
-
-         // Create a trigger that will fire the task at this time every other day
-         td.Triggers.Add(new DailyTrigger { DaysInterval = 2 });
-
-         // Create an action that will launch Notepad whenever the trigger fires
-         td.Actions.Add(new ExecAction("notepad.exe", "c:\\test.log", null));
-
-         // Register the task in the root folder.
-         // (Use the username here to ensure remote registration works.)
-         ts.RootFolder.RegisterTaskDefinition(@"Test", td, TaskCreation.CreateOrUpdate, "username");
-      }
-   }
-}
-```
-
+## About
+The original and most popular .NET wrapper for the [Windows Task Scheduler](https://docs.microsoft.com/en-us/windows/win32/taskschd/task-scheduler-start-page). It provides functionally complete classes that cover all development aspects related to system tasks.
+
+More information can be found on the [project page on GitHub](https://github.com/dahall/taskscheduler).
+
+## Support
+Below are links to sites that provide in-depth examples, documentation and discussions. Please go here first with your questions as the community has been active for over a decade.
+* [Wiki](https://github.com/dahall/TaskScheduler/wiki) - Sample code, library how-to, troubleshooting, etc.
+* [API documentation](https://dahall.github.io/TaskScheduler) - Class/method/property documentation and examples
+* [Full Issues Log](https://github.com/dahall/TaskScheduler/issues?q=) - Use the search box to see if your question may already be answered.
+* [Discussion Forum](https://github.com/dahall/TaskScheduler/discussions) - Users helping users, enhancement requests, Q&A (retired Google forum [here](https://groups.google.com/forum/#!forum/taskscheduler))
+* [Troubleshooting Tool](https://github.com/dahall/TaskSchedulerConfig) - Tool to help identify and fix configuration and connectivity issues. (ClickOnce installer [here](https://github.com/dahall/TaskSchedulerConfig/blob/master/publish/setup.exe?raw=true))
+
+## Key Features
+Microsoft introduced version 2.0 (internally version 1.2) with a completely new object model with Windows Vista. The managed assembly closely resembles the new object model but allows the 1.0 (internally version 1.1) COM objects to be manipulated. It will automatically choose the most recent version of the library found on the host system (up through 1.4). Core features include:
+
+* Separate, functionally identical, libraries for .NET 2.0, 3.5, 4.0, 4.52, 5.0, 6.0, .NET Standard 2.0, .NET Core 2.0, 2.1, 3.0, 3.1.
+* Unlike the base COM libraries, this wrapper accommodates creating and viewing tasks up and down stream.
+* Supports all V2 native properties, even under V1 tasks.
+* Maintain EmailAction and ShowMessageAction using PowerShell scripts for systems after Win8 where these actions have been deprecated.
+* Supports all action types (not just ExecAction) on V1 systems (XP/WS2003) and earlier (if PowerShell is installed).
+* Supports multiple actions on V1 systems (XP/WS2003). Native library only supports a single action.
+* Supports serialization to XML for both 1.0 and 2.0 tasks (base library only supports 2.0)
+* Supports task validation for targeted version.
+* Supports secure task reading and maintenance.
+* Fluent methods for task creation.
+* Cron syntax for trigger creation.
+
+The currently supported localizations include: English, Spanish, Italian, French, Chinese (Simplified), German, Polish and Russian.
+
+## Usage
+You can perform several actions in a single line of code:  
+```C#
+// Run a program every day on the local machine
+TaskService.Instance.AddTask("Test", QuickTriggerType.Daily, "myprogram.exe", "-a arg");
+
+// Run a custom COM handler on the last day of every month
+TaskService.Instance.AddTask("Test", new MonthlyTrigger { RunOnLastDayOfMonth = true }, 
+    new ComHandlerAction(new Guid("{CE7D4428-8A77-4c5d-8A13-5CAB5D1EC734}")));
+```
+
+For many more options, use the library classes to build a complex task. Below is a brief example of how to use the library from C#.  
+```C#
+using System;
+using Microsoft.Win32.TaskScheduler;
+
+class Program
+{
+   static void Main()
+   {
+      // Get the service on the remote machine
+      using (TaskService ts = new TaskService(@"\\RemoteServer", "username", "domain", "password"))
+      {
+         // Create a new task definition and assign properties
+         TaskDefinition td = ts.NewTask();
+         td.RegistrationInfo.Description = "Does something";
+
+         // Create a trigger that will fire the task at this time every other day
+         td.Triggers.Add(new DailyTrigger { DaysInterval = 2 });
+
+         // Create an action that will launch Notepad whenever the trigger fires
+         td.Actions.Add(new ExecAction("notepad.exe", "c:\\test.log", null));
+
+         // Register the task in the root folder.
+         // (Use the username here to ensure remote registration works.)
+         ts.RootFolder.RegisterTaskDefinition(@"Test", td, TaskCreation.CreateOrUpdate, "username");
+      }
+   }
+}
+```
+
 For extended examples on how to the use the library, look at the [Examples Page](https://github.com/dahall/TaskScheduler/wiki/Examples).