Skip to content

Commit be67047

Browse files
committed
Keep documentation up to date with release 0.4.6
1 parent d07121c commit be67047

File tree

41 files changed

+1061
-1023
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1061
-1023
lines changed

content/usage/osctrl-cli/_index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ pre = ""
1010
Execute `./osctrl-cli help` to show the main help of the program:
1111

1212
```properties
13-
$ ./osctrl-cli help
13+
$ ./bin/osctrl-cli help
1414
NAME:
1515
osctrl-cli - CLI for osctrl
1616

1717
USAGE:
18-
osctrl-cli [global options] command [command options] [arguments...]
18+
osctrl-cli [global options] command [command options]
1919

2020
VERSION:
21-
0.4.1
21+
0.4.6
2222

2323
DESCRIPTION:
2424
CLI for osctrl, a fast and efficient osquery management
@@ -52,10 +52,11 @@ GLOBAL OPTIONS:
5252
--db-max-open-conns value Maximum number of open connections to the database (default: 100) [$DB_MAX_OPEN_CONNS]
5353
--db-conn-max-lifetime value Maximum amount of time a connection may be reused (default: 30) [$DB_CONN_MAX_LIFETIME]
5454
--insecure, -i Allow insecure server connections when using SSL (default: false)
55+
--verbose, -V Increase output verbosity for debugging (default: false)
5556
--output-format value, -o value Format to be used for data output (default: "pretty") [$OUTPUT_FORMAT]
5657
--silent, -s Silent mode (default: false)
57-
--help, -h show help
58-
--version, -v print the version
58+
--help, -h Show help (default: false)
59+
--version, -v Print version information (default: false)
5960
```
6061

6162
Each command has its own help and it is displayed appending `-h` to them. Each subcommand has its own help as well.

content/usage/osctrl-cli/check-api/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ pre = ""
88
### Check
99

1010
```properties
11-
$ ./osctrl-cli check-api -h
11+
$ ./bin/osctrl-cli check-api -h
1212
NAME:
1313
osctrl-cli check-api - Checks API token
1414

1515
USAGE:
16-
osctrl-cli check-api [command options] [arguments...]
16+
osctrl-cli check-api [command options]
1717

1818
OPTIONS:
19-
--help, -h show help
19+
--help, -h Show help (default: false)
2020
```
2121

2222
Although this command may appear a bit confusing, it comes in really handy to verify when the `osctrl-api` component is ready to go and the validity of a token.

content/usage/osctrl-cli/node/_index.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,87 +8,104 @@ pre = ""
88
### Node
99

1010
```properties
11-
$ ./osctrl-cli node -h
11+
$ ./bin/osctrl-cli node -h
1212
NAME:
1313
osctrl-cli node - Commands for nodes
1414

1515
USAGE:
16-
osctrl-cli node command [command options] [arguments...]
16+
osctrl-cli node [command options]
1717

1818
COMMANDS:
1919
delete, d Delete and archive an existing node
2020
tag, t Tag an existing node
2121
list, l List enrolled nodes
2222
show, s Show an existing node
23+
lookup, f Lookup existing nodes by identifier (UUID, hostname or localname)
2324
help, h Shows a list of commands or help for one command
2425

2526
OPTIONS:
26-
--help, -h show help
27+
--help, -h Show help (default: false)
2728
```
2829

2930
#### Delete node
3031

3132
```properties
32-
$ ./osctrl-cli node delete -h
33+
$ ./bin/osctrl-cli node delete -h
3334
NAME:
3435
osctrl-cli node delete - Delete and archive an existing node
3536

3637
USAGE:
37-
osctrl-cli node delete [command options] [arguments...]
38+
osctrl-cli node delete [command options]
3839

3940
OPTIONS:
4041
--uuid value, -u value Node UUID to be deleted
4142
--env value, -e value Environment to be used
42-
--help, -h show help
43+
--help, -h Show help (default: false)
4344
```
4445

4546
#### Tag node
4647

4748
```properties
48-
$ ./osctrl-cli node tag -h
49+
$ ./bin/osctrl-cli node tag -h
4950
NAME:
5051
osctrl-cli node tag - Tag an existing node
5152

5253
USAGE:
53-
osctrl-cli node tag [command options] [arguments...]
54+
osctrl-cli node tag [command options]
5455

5556
OPTIONS:
56-
--uuid value, -u value Node UUID to be tagged
57-
--env value, -e value Environment to be used
58-
--tag-value value, -T value Tag value to be used. It will be created if does not exist
59-
--help, -h show help
57+
--uuid value, -u value Node UUID to be tagged
58+
--env value, -e value Environment to be used
59+
--name value, -n value, --tag-value value Tag name to be used. It will be created if does not exist
60+
--tag-type value, --type value Tag type to be used. It can be 'env', 'uuid', 'localname' and 'custom' (default: "custom")
61+
--help, -h Show help (default: false)
6062
```
6163

6264
#### List nodes
6365

6466
```properties
65-
$ ./osctrl-cli node list -h
67+
$ ./bin/osctrl-cli node list -h
6668
NAME:
6769
osctrl-cli node list - List enrolled nodes
6870

6971
USAGE:
70-
osctrl-cli node list [command options] [arguments...]
72+
osctrl-cli node list [command options]
7173

7274
OPTIONS:
7375
--active, -a Show active nodes (default: true)
7476
--all, -A Show all nodes (default: false)
7577
--inactive, -i Show inactive nodes (default: false)
7678
--env value, -e value Environment to be used
77-
--help, -h show help
79+
--help, -h Show help (default: false)
7880
```
7981

8082
#### Show node
8183

8284
```properties
83-
$ ./osctrl-cli node show -h
85+
$ ./bin/osctrl-cli node show -h
8486
NAME:
8587
osctrl-cli node show - Show an existing node
8688

8789
USAGE:
88-
osctrl-cli node show [command options] [arguments...]
90+
osctrl-cli node show [command options]
8991

9092
OPTIONS:
9193
--uuid value, -u value Node UUID to be shown
9294
--env value, -e value Environment to be used
93-
--help, -h show help
95+
--help, -h Show help (default: false)
96+
```
97+
98+
#### Lookup node
99+
100+
```properties
101+
$ ./bin/osctrl-cli node lookup -h
102+
NAME:
103+
osctrl-cli node lookup - Lookup existing nodes by identifier (UUID, hostname or localname)
104+
105+
USAGE:
106+
osctrl-cli node lookup [command options]
107+
108+
OPTIONS:
109+
--identifier value, --id value, -i value Node identifier to be looked up (UUID, hostname or localname)
110+
--help, -h Show help (default: false)
94111
```

content/usage/osctrl-cli/query/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ pre = ""
88
### Query
99

1010
```properties
11-
$ ./osctrl-cli query -h
11+
$ ./bin/osctrl-cli query -h
1212
NAME:
1313
osctrl-cli query - Commands for queries
1414

1515
USAGE:
16-
osctrl-cli query command [command options] [arguments...]
16+
osctrl-cli query [command options]
1717

1818
COMMANDS:
1919
complete, c Mark an on-demand query as completed
@@ -24,7 +24,7 @@ COMMANDS:
2424
help, h Shows a list of commands or help for one command
2525

2626
OPTIONS:
27-
--help, -h show help
27+
--help, -h Show help (default: false)
2828
```
2929

3030
#### Complete query

0 commit comments

Comments
 (0)