@kinosec/cli 0.1.1 → 0.1.2
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 +105 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# @kinosec/cli
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@kinosec/cli)
|
|
4
|
+
[](https://nodejs.org)
|
|
5
|
+
|
|
6
|
+
The official CLI for [KinoSec](https://kinosec.ai) — run pentests from your terminal.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install -g @kinosec/cli
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Or run without installing:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx @kinosec/cli scan list
|
|
18
|
+
```
|
|
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
|
+
## Quick Start
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# Authenticate with a Personal Access Token
|
|
28
|
+
kns auth login
|
|
29
|
+
|
|
30
|
+
# List your assets
|
|
31
|
+
kns asset list
|
|
32
|
+
|
|
33
|
+
# Run a quick pentest
|
|
34
|
+
kns scan create --asset <id> --mode quick
|
|
35
|
+
|
|
36
|
+
# Watch progress in real-time
|
|
37
|
+
kns scan watch <scan-id>
|
|
38
|
+
|
|
39
|
+
# View findings
|
|
40
|
+
kns finding list --scan <scan-id>
|
|
41
|
+
|
|
42
|
+
# Export a report
|
|
43
|
+
kns report export --scan <report-id> --format markdown > report.md
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
See [docs/quickstart.md](docs/quickstart.md) for a full walkthrough.
|
|
47
|
+
|
|
48
|
+
## Commands
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
kns auth login|status|logout Manage authentication
|
|
52
|
+
kns config set|get|list Manage CLI configuration
|
|
53
|
+
kns me Show authenticated user info
|
|
54
|
+
|
|
55
|
+
kns asset list|get|create|delete|verify Manage assets
|
|
56
|
+
kns scan list|get|create|cancel|watch Manage security scans
|
|
57
|
+
kns finding list|get|update|retest Manage findings
|
|
58
|
+
kns report list|get|export Manage reports
|
|
59
|
+
kns token list|create|revoke Manage API tokens
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Every command supports `--json` for machine-readable output and `--help` for usage details.
|
|
63
|
+
|
|
64
|
+
See [docs/commands.md](docs/commands.md) for the full command reference.
|
|
65
|
+
|
|
66
|
+
## Authentication
|
|
67
|
+
|
|
68
|
+
The CLI authenticates via Personal Access Tokens (PATs). Tokens are resolved in this order:
|
|
69
|
+
|
|
70
|
+
1. `--token` flag
|
|
71
|
+
2. `KINOSEC_TOKEN` environment variable
|
|
72
|
+
3. `~/.config/kinosec/credentials.json` (saved by `kns auth login`)
|
|
73
|
+
|
|
74
|
+
See [docs/authentication.md](docs/authentication.md) for details.
|
|
75
|
+
|
|
76
|
+
## Example
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
$ kns auth login
|
|
80
|
+
Paste your API token: ****
|
|
81
|
+
✓ Authenticated as you@example.com
|
|
82
|
+
Plan: security_pro (pro)
|
|
83
|
+
Org: Acme Inc
|
|
84
|
+
|
|
85
|
+
$ kns scan list
|
|
86
|
+
ID Target Mode Status Created
|
|
87
|
+
bc6b13bc-1234-5678-9abc-def012345678 example.com quick Completed 5/1/2026
|
|
88
|
+
|
|
89
|
+
$ kns finding list --scan bc6b13bc-1234-5678-9abc-def012345678
|
|
90
|
+
ID Name Severity Status Phase
|
|
91
|
+
f1a2b3c4-... SQL Injection Critical open active_scan
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Requirements
|
|
95
|
+
|
|
96
|
+
- Node.js >= 20.0.0 (for npm install)
|
|
97
|
+
- No requirements for standalone binaries
|
|
98
|
+
|
|
99
|
+
## Contributing
|
|
100
|
+
|
|
101
|
+
This CLI is maintained by [KinoSec](https://kinosec.ai). External contributions are not accepted at this time. Bug reports via Issues are welcome.
|
|
102
|
+
|
|
103
|
+
## License
|
|
104
|
+
|
|
105
|
+
Proprietary. See [LICENSE.md](LICENSE.md) for terms.
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kinosec/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Official KinoSec command-line interface",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": { "kns": "./dist/cli.js" },
|
|
7
|
-
"files": ["dist", "LICENSE.md"],
|
|
7
|
+
"files": ["dist", "LICENSE.md", "README.md"],
|
|
8
8
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
9
9
|
"author": "KinoSec, Inc.",
|
|
10
10
|
"homepage": "https://kinosec.ai",
|