@signageos/cli 2.5.0 → 2.6.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/dist/Applet/Generate/appletGenerateCommand.js +1 -1
  2. package/dist/CustomScript/customScriptFacade.d.ts +5 -5
  3. package/dist/CustomScript/customScriptFacade.js +5 -4
  4. package/dist/Plugin/Generate/pluginGenerateCommand.d.ts +7 -0
  5. package/dist/Plugin/Generate/pluginGenerateCommand.js +38 -0
  6. package/dist/Plugin/Generate/pluginGenerateFacade.d.ts +12 -0
  7. package/dist/Plugin/Generate/pluginGenerateFacade.js +106 -0
  8. package/dist/Plugin/Upload/pluginUploadCommand.d.ts +25 -0
  9. package/dist/Plugin/Upload/pluginUploadCommand.js +70 -0
  10. package/dist/Plugin/pluginCommand.d.ts +27 -0
  11. package/dist/Plugin/pluginCommand.js +26 -0
  12. package/dist/Plugin/pluginFacade.d.ts +62 -0
  13. package/dist/Plugin/pluginFacade.js +251 -0
  14. package/dist/Runner/Generate/runnerGenerateCommand.d.ts +7 -0
  15. package/dist/Runner/Generate/runnerGenerateCommand.js +38 -0
  16. package/dist/Runner/Generate/runnerGenerateFacade.d.ts +12 -0
  17. package/dist/Runner/Generate/runnerGenerateFacade.js +107 -0
  18. package/dist/Runner/Upload/runnerUploadCommand.d.ts +25 -0
  19. package/dist/Runner/Upload/runnerUploadCommand.js +72 -0
  20. package/dist/Runner/runnerCommand.d.ts +27 -0
  21. package/dist/Runner/runnerCommand.js +26 -0
  22. package/dist/Runner/runnerFacede.d.ts +15 -0
  23. package/dist/Runner/runnerFacede.js +234 -0
  24. package/dist/index.js +3 -1
  25. package/docs/applet/index.md +10 -10
  26. package/docs/applet/test/index.md +4 -4
  27. package/docs/autocomplete/index.md +4 -4
  28. package/docs/custom-script/index.md +4 -4
  29. package/docs/device/index.md +6 -6
  30. package/docs/index.md +16 -14
  31. package/docs/organization/index.md +6 -6
  32. package/docs/plugin/generate/index.md +43 -0
  33. package/docs/plugin/index.md +72 -0
  34. package/docs/plugin/upload/index.md +50 -0
  35. package/docs/runner/generate/index.md +43 -0
  36. package/docs/runner/index.md +72 -0
  37. package/docs/runner/upload/index.md +50 -0
  38. package/docs/timing/index.md +2 -2
  39. package/package.json +2 -2
package/docs/plugin/upload/index.md ADDED
@@ -0,0 +1,50 @@
1
+ ---
2
+ id: plugin-upload-index
3
+ title: upload
4
+ sidebar_position: 0
5
+ ---
6
+ # upload
7
+
8
+ Uploads current plugin version
9
+
10
+
11
+ ## Usage
12
+
13
+ ```bash
14
+ sos plugin upload [options]
15
+ ```
16
+
17
+ ## Options
18
+
19
+ | Option | Description |
20
+ | --------------------------- | ---------------------------------------------------------------- |
21
+ | `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
22
+ | `--organization-uid` | Organization UID (string) |
23
+
24
+ ## Global Options
25
+
26
+ All commands support the following global options:
27
+
28
+ | Option | Alias | Description |
29
+ |--------|-------|-------------|
30
+ | `--help` | `-h` | Display help information for any command |
31
+ | `--version` | `-v` | Display the installed version of the CLI |
32
+ | `--api-url` | `-u` | Override the API URL for REST requests |
33
+ | `--profile` | | Use a specific profile from ~/.sosrc config |
34
+
35
+ ### Examples
36
+
37
+ ```bash
38
+ # Show version
39
+ sos --version
40
+
41
+ # Get help for any command
42
+ sos applet --help
43
+ sos applet upload --help
44
+
45
+ # Use custom API endpoint
46
+ sos --api-url https://api.example.com applet upload
47
+
48
+ # Use specific profile
49
+ sos --profile production organization list
50
+ ```
package/docs/runner/generate/index.md ADDED
@@ -0,0 +1,43 @@
1
+ ---
2
+ id: runner-generate-index
3
+ title: generate
4
+ sidebar_position: 0
5
+ ---
6
+ # generate
7
+
8
+ Generates a local repository for developing a Runner
9
+
10
+
11
+ ## Usage
12
+
13
+ ```bash
14
+ sos runner generate [options]
15
+ ```
16
+
17
+ ## Global Options
18
+
19
+ All commands support the following global options:
20
+
21
+ | Option | Alias | Description |
22
+ |--------|-------|-------------|
23
+ | `--help` | `-h` | Display help information for any command |
24
+ | `--version` | `-v` | Display the installed version of the CLI |
25
+ | `--api-url` | `-u` | Override the API URL for REST requests |
26
+ | `--profile` | | Use a specific profile from ~/.sosrc config |
27
+
28
+ ### Examples
29
+
30
+ ```bash
31
+ # Show version
32
+ sos --version
33
+
34
+ # Get help for any command
35
+ sos applet --help
36
+ sos applet upload --help
37
+
38
+ # Use custom API endpoint
39
+ sos --api-url https://api.example.com applet upload
40
+
41
+ # Use specific profile
42
+ sos --profile production organization list
43
+ ```
package/docs/runner/index.md ADDED
@@ -0,0 +1,72 @@
1
+ ---
2
+ id: runner-index
3
+ title: runner
4
+ sidebar_position: 0
5
+ ---
6
+ # runner
7
+
8
+ Runner management
9
+
10
+
11
+ ## Usage
12
+
13
+ ```bash
14
+ sos runner <subcommand> [options]
15
+ ```
16
+
17
+ ## Subcommands
18
+
19
+ ### generate
20
+
21
+ Generates a local repository for developing a Runner
22
+
23
+ ```bash
24
+ sos runner generate [options]
25
+ ```
26
+
27
+ [→ See detailed documentation](/cli/runner/generate/)
28
+
29
+ ### upload
30
+
31
+ Uploads current runner version
32
+
33
+ ```bash
34
+ sos runner upload [options]
35
+ ```
36
+
37
+ [→ See detailed documentation](/cli/runner/upload/)
38
+
39
+
40
+ ## Global Options
41
+
42
+ All commands support the following global options:
43
+
44
+ | Option | Alias | Description |
45
+ |--------|-------|-------------|
46
+ | `--help` | `-h` | Display help information for any command |
47
+ | `--version` | `-v` | Display the installed version of the CLI |
48
+ | `--api-url` | `-u` | Override the API URL for REST requests |
49
+ | `--profile` | | Use a specific profile from ~/.sosrc config |
50
+
51
+ ### Examples
52
+
53
+ ```bash
54
+ # Show version
55
+ sos --version
56
+
57
+ # Get help for any command
58
+ sos applet --help
59
+ sos applet upload --help
60
+
61
+ # Use custom API endpoint
62
+ sos --api-url https://api.example.com applet upload
63
+
64
+ # Use specific profile
65
+ sos --profile production organization list
66
+ ```
67
+
68
+
69
+ ## Related Commands
70
+
71
+ - [`sos runner generate`](/cli/runner/generate/) - Generates a local repository for developing a Runner
72
+ - [`sos runner upload`](/cli/runner/upload/) - Uploads current runner version
package/docs/runner/upload/index.md ADDED
@@ -0,0 +1,50 @@
1
+ ---
2
+ id: runner-upload-index
3
+ title: upload
4
+ sidebar_position: 0
5
+ ---
6
+ # upload
7
+
8
+ Uploads current runner version
9
+
10
+
11
+ ## Usage
12
+
13
+ ```bash
14
+ sos runner upload [options]
15
+ ```
16
+
17
+ ## Options
18
+
19
+ | Option | Description |
20
+ | --------------------------- | ---------------------------------------------------------------- |
21
+ | `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
22
+ | `--organization-uid` | Organization UID (string) |
23
+
24
+ ## Global Options
25
+
26
+ All commands support the following global options:
27
+
28
+ | Option | Alias | Description |
29
+ |--------|-------|-------------|
30
+ | `--help` | `-h` | Display help information for any command |
31
+ | `--version` | `-v` | Display the installed version of the CLI |
32
+ | `--api-url` | `-u` | Override the API URL for REST requests |
33
+ | `--profile` | | Use a specific profile from ~/.sosrc config |
34
+
35
+ ### Examples
36
+
37
+ ```bash
38
+ # Show version
39
+ sos --version
40
+
41
+ # Get help for any command
42
+ sos applet --help
43
+ sos applet upload --help
44
+
45
+ # Use custom API endpoint
46
+ sos --api-url https://api.example.com applet upload
47
+
48
+ # Use specific profile
49
+ sos --profile production organization list
50
+ ```
package/docs/timing/index.md CHANGED
@@ -30,7 +30,7 @@ List timing configurations assigned to a device
30
30
  sos timing list [options]
31
31
  ```
32
32
 
33
- [→ See detailed documentation](list/)
33
+ [→ See detailed documentation](/cli/timing/list/)
34
34
 
35
35
 
36
36
  ## Examples
@@ -75,4 +75,4 @@ sos --profile production organization list
75
75
 
76
76
  ## Related Commands
77
77
 
78
- - [`sos timing list`](list/) - List timing configurations assigned to a device
78
+ - [`sos timing list`](/cli/timing/list/) - List timing configurations assigned to a device
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@signageos/cli",
3
- "version": "2.5.0",
3
+ "version": "2.6.0-rc.0",
4
4
  "main": "./dist/index.js",
5
5
  "author": "signageOS.io <dev@signageos.io>",
6
6
  "files": [
@@ -84,7 +84,7 @@
84
84
  },
85
85
  "dependencies": {
86
86
  "@signageos/file": "1.0.1",
87
- "@signageos/sdk": "1.28.1",
87
+ "@signageos/sdk": "1.29.0",
88
88
  "archiver": "7.0.1",
89
89
  "chalk": "2.4.2",
90
90
  "child-process-promise": "2.2.1",