1 | # Freedcamp Script Runner
|
2 |
|
3 | The best script runner of ALL time!
|
4 |
|
5 | # Installation
|
6 |
|
7 | ```bash
|
8 | yarn add -D fscripts
|
9 | ```
|
10 |
|
11 | We recommend to add the following line to your `package.json`
|
12 |
|
13 | ```json5
|
14 | {
|
15 | scripts: {
|
16 | fsr: "fsr",
|
17 | start: "fsr start",
|
18 | list: "fsr list"
|
19 | }
|
20 | }
|
21 | ```
|
22 |
|
23 | # Usage
|
24 |
|
25 | ```bash
|
26 | fsr <command> [options]
|
27 | ```
|
28 |
|
29 | # Commands
|
30 |
|
31 | ```bash
|
32 | fsr Choose a script runner command
|
33 | fsr start Choose category then task to run
|
34 | fsr scripts Choose a script from package.json
|
35 | fsr list Select any task with text autocompletion
|
36 | fsr run Run a specific task
|
37 | fsr run-s Run a set of tasks one after another
|
38 | fsr run-p Run tasks in parallel
|
39 | fsr clear Clear recent task history
|
40 | fsr generate Generate a sample fscripts.md file from the package.json
|
41 | fsr toc Generate updated Table of Contents on top of the fscripts.md file
|
42 |
|
43 |
|
44 | Options:
|
45 | --help Show help
|
46 | --version Show version number
|
47 | ```
|
48 |
|
49 | # Examples
|
50 |
|
51 | ```bash
|
52 | fsr Choose a script runner command
|
53 | fsr start Open a task selection selector
|
54 | fsr scripts Choose a script from package.json
|
55 | fsr upgrade Upgrade all dependencies from package.json, except ones inside the fscripts.ignore-upgrade
|
56 | fsr list Show you all tasks you can run
|
57 | fsr run start:web Run task 'start:web'
|
58 | fsr run-s start:web start:desktop Run task 'start:web' and afterwards 'start:desktop'
|
59 | fsr run-p start:web start:desktop Run task 'start:web' and at the same time 'start:desktop'
|
60 | fsr clear Clear your recently run tasks
|
61 | fsr generate Generates a sample.fscripts.md you can use as template for your fscripts file
|
62 | fsr toc Generate updated Table of Contents on top of the fscripts.md file
|
63 | ```
|