@kinosec/cli 0.2.0 → 0.3.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.
- package/README.md +18 -29
- package/dist/cli.js +222 -132
- package/dist/cli.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,13 +14,9 @@ npm install -g @kinosec/cli
|
|
|
14
14
|
Or run without installing:
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
npx @kinosec/cli
|
|
17
|
+
npx @kinosec/cli pentest list
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Or download a standalone binary from [GitHub Releases](https://github.com/kinosec-ai/cli/releases) — no Node.js required.
|
|
21
|
-
|
|
22
|
-
See [docs/install.md](docs/install.md) for all installation methods.
|
|
23
|
-
|
|
24
20
|
## Quick Start
|
|
25
21
|
|
|
26
22
|
```bash
|
|
@@ -30,24 +26,22 @@ kinosec auth login
|
|
|
30
26
|
# List your assets
|
|
31
27
|
kinosec asset list
|
|
32
28
|
|
|
33
|
-
# Run a
|
|
34
|
-
kinosec
|
|
29
|
+
# Run a pentest
|
|
30
|
+
kinosec pentest -t example.com
|
|
35
31
|
|
|
36
32
|
# Watch progress in real-time
|
|
37
|
-
kinosec
|
|
33
|
+
kinosec pentest watch <profile-id>
|
|
38
34
|
|
|
39
|
-
# Schedule a weekly
|
|
40
|
-
kinosec
|
|
35
|
+
# Schedule a weekly pentest
|
|
36
|
+
kinosec pentest schedule create --asset <id> --pattern weekly --day-of-week 1 --time 09:00
|
|
41
37
|
|
|
42
38
|
# View findings
|
|
43
39
|
kinosec finding list --scan <scan-id>
|
|
44
40
|
|
|
45
41
|
# Export a report
|
|
46
|
-
kinosec report export
|
|
42
|
+
kinosec report export <report-id> --format markdown > report.md
|
|
47
43
|
```
|
|
48
44
|
|
|
49
|
-
See [docs/quickstart.md](docs/quickstart.md) for a full walkthrough.
|
|
50
|
-
|
|
51
45
|
## Commands
|
|
52
46
|
|
|
53
47
|
```
|
|
@@ -55,9 +49,9 @@ kinosec auth login|status|logout Manage authentication
|
|
|
55
49
|
kinosec config set|get|list Manage CLI configuration
|
|
56
50
|
kinosec me Show authenticated user info
|
|
57
51
|
|
|
58
|
-
kinosec asset list|get|create|delete|verify
|
|
59
|
-
kinosec
|
|
60
|
-
kinosec
|
|
52
|
+
kinosec asset list|get|create|delete|verify Manage assets
|
|
53
|
+
kinosec pentest [-t domain]|list|get|cancel|watch Run and manage pentests
|
|
54
|
+
kinosec pentest schedule create|list|get|... Schedule recurring pentests
|
|
61
55
|
kinosec finding list|get|update|retest Manage findings
|
|
62
56
|
kinosec report list|get|export Manage reports
|
|
63
57
|
kinosec token list|create|revoke Manage API tokens
|
|
@@ -65,8 +59,6 @@ kinosec token list|create|revoke Manage API tokens
|
|
|
65
59
|
|
|
66
60
|
Every command supports `--json` for machine-readable output and `--help` for usage details.
|
|
67
61
|
|
|
68
|
-
See [docs/commands.md](docs/commands.md) for the full command reference.
|
|
69
|
-
|
|
70
62
|
## Authentication
|
|
71
63
|
|
|
72
64
|
The CLI authenticates via Personal Access Tokens (PATs). Tokens are resolved in this order:
|
|
@@ -75,34 +67,31 @@ The CLI authenticates via Personal Access Tokens (PATs). Tokens are resolved in
|
|
|
75
67
|
2. `KINOSEC_TOKEN` environment variable
|
|
76
68
|
3. `~/.config/kinosec/credentials.json` (saved by `kinosec auth login`)
|
|
77
69
|
|
|
78
|
-
See [docs/authentication.md](docs/authentication.md) for details.
|
|
79
|
-
|
|
80
70
|
## Example
|
|
81
71
|
|
|
82
72
|
```bash
|
|
83
73
|
$ kinosec auth login
|
|
84
|
-
|
|
74
|
+
API token: ********
|
|
85
75
|
✓ Authenticated as you@example.com
|
|
86
76
|
Plan: security_pro (pro)
|
|
87
77
|
Org: Acme Inc
|
|
88
78
|
|
|
89
|
-
$ kinosec
|
|
79
|
+
$ kinosec pentest list
|
|
90
80
|
ID Target Mode Status Created
|
|
91
|
-
|
|
81
|
+
a1b2c3d4-0000-0000-0000-000000000001 example.com full Completed 5/1/2026
|
|
92
82
|
|
|
93
|
-
$ kinosec finding list --scan
|
|
94
|
-
ID Name Severity Status
|
|
95
|
-
|
|
83
|
+
$ kinosec finding list --scan a1b2c3d4-0000-0000-0000-000000000001
|
|
84
|
+
ID Name Severity Status
|
|
85
|
+
b2c3d4e5-0000-0000-0000-000000000001 SQL Injection Critical open
|
|
96
86
|
```
|
|
97
87
|
|
|
98
88
|
## Requirements
|
|
99
89
|
|
|
100
|
-
- Node.js >= 20.0.0
|
|
101
|
-
- No requirements for standalone binaries
|
|
90
|
+
- Node.js >= 20.0.0
|
|
102
91
|
|
|
103
92
|
## Contributing
|
|
104
93
|
|
|
105
|
-
This CLI is maintained by [KinoSec](https://kinosec.ai). External contributions are not accepted at this time.
|
|
94
|
+
This CLI is maintained by [KinoSec](https://kinosec.ai). External contributions are not accepted at this time.
|
|
106
95
|
|
|
107
96
|
## License
|
|
108
97
|
|