CLI Reference

censys

usage: censys [-h] [-v] {search,hnri,config,config-asm} ...

-h, --help

show this help message and exit

-v, --version

display version

censys config

Configure Censys Search API Settings

usage: censys config [-h]

-h, --help

show this help message and exit

censys config-asm

Configure Censys ASM API Settings

usage: censys config-asm [-h]

-h, --help

show this help message and exit

censys hnri

Home Network Risk Identifier (H.N.R.I.)

usage: censys hnri [-h] [--api-id API_ID] [--api-secret API_SECRET]

-h, --help

show this help message and exit

--api-id <api_id>

a Censys API ID (alternatively you can use the env variable CENSYS_API_ID)

--api-secret <api_secret>

a Censys API SECRET (alternatively you can use the env variable CENSYS_API_SECRET)

censys search

Query Censys Search for resource data by providing a query string, the resource index, and the fields to be returned

usage: censys search [-h] [--api-id API_ID] [--api-secret API_SECRET] -q QUERY
                     [--index-type ipv4|certs|websites]
                     [--fields FIELDS [FIELDS ...]] [--overwrite]
                     [-f json|csv|screen] [-o OUTPUT]
                     [--start-page START_PAGE] [--max-pages MAX_PAGES]

-h, --help

show this help message and exit

--api-id <api_id>

a Censys API ID (alternatively you can use the env variable CENSYS_API_ID)

--api-secret <api_secret>

a Censys API SECRET (alternatively you can use the env variable CENSYS_API_SECRET)

-q <query>, --query <query>

a string written in Censys Search syntax

--index-type {ipv4,certs,websites}

which resource index to query

--fields <fields>

list of index-specific fields

--overwrite

overwrite instead of append fields returned by default with fields provided in the fields argument

-f <json|csv|screen>, --format <json|csv|screen>

format of output

-o <output>, --output <output>

output file path

--start-page <start_page>

page number to start from

--max-pages <max_pages>

maximum number of pages of results to return