Skip to content

Commit 7f592cd

Browse files
committed
Updated documentation
1 parent ef3beba commit 7f592cd

File tree

5 files changed

+38
-15
lines changed

5 files changed

+38
-15
lines changed

Docs/Job.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Run your command as a job
2+
A PowerCommands application can be started with arguments from the commandline which is usefull when you want to use your PowerCommands implementation to perform something as a automated job.
3+
4+
The code below shos a dummie example of how you design your Command to run as an automatated task, notice the **return Quit()** at the end of the Run() method, that will trigger the program to quit the application.
5+
6+
![Alt text](images/job.png?raw=true "job")
7+
8+
You just startup your PowerCommands application from with the parameter "job", like this:
9+
```
10+
"powercommands.exe job"
11+
```
12+
Your PowerCommands application may of course have so other name and your command could have Input parameters that will be passed on from the command line like this:
13+
```
14+
"powercommands.exe job argument1"
15+
```
16+
17+
Read more about:
18+
19+
[Design your Command](Design_command.md)
20+
21+
[Options](Options.md)
22+
23+
[PowerCommands Attribute](PowerCommandAttribute.md)
24+
25+
[Back to start](https://github.com/PowerCommands/PowerCommands2022/blob/main/Docs/README.md)

Docs/PowerCommandDesignAttribute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Describe your quotes, separate them with | use // to display a commented line ov
4646
Suggestion will be added to the autocomplete functionallity so the user could use tab to cycle trough the commands and commands with a suggested argument.
4747
### Options
4848
Describe your options, separate them with | use // to display a commented line over the actual option, all options that are described will also be used by the autocomplete functionallity to help the user find the right option.
49-
Read more about [options](options.md).
49+
Read more about [options](Options.md).
5050
### secrets
5151
Describe your secrets that the commands needs, you probably want to declare a secret as required with **!** character, in the sample above secret **cnDatabase** is marked as required.
5252
```

Docs/Secrets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Configure your environment to use Encryption/Decryption and Secrets functionallity
44
## Good to know
55
Secret is initialized the fist time you startup a new power command project on your machine, the same keys for encryption/decryption is used by all your PowerCommands based applications on the same machine.
6-
If you setup PowerCommands on a diffrent machine, a new key for encryption/decryption will be used, meaning you have to create the secrets again on that machine. But you can move the keys manually, but I do not think that you should do that.
6+
If you setup PowerCommands on a diffrent machine, a new key for encryption/decryption will be created for that machine. It is possible to manually move both the key and the encrypted secrets from one machine to another, but it is not recommended and therefore not documented.
77
## Use the secrets built in functionallity
88
Create secret with built in commands named secret, like this:
99
```

Docs/images/job.png

95.4 KB
Loading

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,18 @@ You could se PowerCommands as an easy Create your CLI applikation starter kit. I
44
[Follow progress on twitter](https://twitter.com/PowerCommands) <img src="https://github.com/PowerCommands/PowerCommands2022/blob/main/Docs/images/Twitter.png?raw=true" alt="drawing" width="20"/>
55

66
### The core components offering this to your custom PowerCommands
7-
- Logging (using Microsoft.Extensions.Logging.ILogger)
8-
- Process log (using the standard logger with tags to track a process)
7+
- Command completion, with history, suggestions, options and support for Path/File navigation and color highlightning when typing a valid command
8+
- Secret handling to protect sensitive information like password or authentication tokens in the configuration file.
99
- Configuration with YAML (built to be very easy to extend)
10-
- Display your POCO:s easy with a nice Console Table display output
11-
- Simple to write test rules with attribute
10+
- Logging (using Microsoft.Extensions.Logging.ILogger)
11+
- Built in help system with the use of attributes
12+
- Run as job
1213
- Validation rules with attribute
13-
- Diagnostic
14-
- Secret handling to protect sensitive information like password or authentication tokens in the configuration file.
15-
- Command completion, with history, suggestions, options and support for Path/File navigation and color highlightning when typing a valid command
14+
- Diagnostic
1615
- Progressbar
17-
- Download files
18-
- Password prompt
19-
- Run as job
20-
- Zip with attributes like checksum, filecount and file size
21-
- Describe your commands with code examples using attributes.
16+
- Dialog service (with password prompting)
2217

23-
![Alt text](Docs/images/startup.png?raw=true "Test result")
18+
![Alt text](Docs/images/startup.png?raw=true "Startup")
2419

2520
## Start your journey
2621
[Create a new VS Solution](Docs/Create_new_%20project.md)
@@ -42,6 +37,9 @@ You could se PowerCommands as an easy Create your CLI applikation starter kit. I
4237

4338
[Output to the Console guidline](Docs/ConsoleOutput.md)
4439

40+
## Automation
41+
[Run your command as job](Docs/Job.md)
42+
4543
## Core framework
4644
[PowerCommandsRuntime](Docs/PowerCommandsRuntime.md)
4745

0 commit comments

Comments
 (0)