Skip to content

Commit e522a77

Browse files
committed
feat: add connect new source command
1 parent a68da7f commit e522a77

11 files changed

Lines changed: 1130 additions & 62 deletions

File tree

CHANGES

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
1.10.1
4444
-----
45-
- Add command for sending phishing emails from a directory to Intezer Analyze
45+
- Add command for sending phishing emails from a directory to Intezer Platform
4646
- Upgrade intezer-SDK to 1.19.9
4747

4848
1.9.3

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# intezer-analyze
1+
# intezer-cli
22

3-
A cross-platform CLI tool which enables analyzing files with Intezer Analyze.
3+
A cross-platform CLI tool which enables analyzing files with Intezer AI-SOC Platform.
44

55
# Prerequisites
66
Python 3.10 and above
@@ -18,54 +18,54 @@ The CLI supports proxies. To use a proxy, set the environment variable `HTTP_PRO
1818
## Login
1919
To begin using the cli, first you should login with your API key:
2020

21-
`intezer-analyze login <api_key>`
21+
`intezer-cli login <api_key>`
2222

2323
If you are running the CLI against an on premise deployment, enter the url:
2424

25-
`intezer-analyze login <api_key> http://<address>/api`
25+
`intezer-cli login <api_key> http://<address>/api`
2626

2727

2828
## Analyze
29-
Send a file or a directory for analysis in Intezer Analyze.
29+
Send a file or a directory for analysis in Intezer Platform.
3030

3131
### Usage
32-
`intezer-analyze analyze PATH`
32+
`intezer-cli analyze PATH`
3333

3434
### Parameters
3535
PATH: Path to file or directory to send the files inside for analysis.
3636

3737
### Examples:
3838
Send a single file for analysis:
3939

40-
$ intezer-analyze analyze C:\threat.exe
40+
$ intezer-cli analyze C:\threat.exe
4141

4242
Send all files in directory for analysis:
4343

44-
$ intezer-analyze analyze C:\files-to-analyze
44+
$ intezer-cli analyze C:\files-to-analyze
4545

46-
For complete documentation please run `intezer-analyze analyze --help`
46+
For complete documentation please run `intezer-cli analyze --help`
4747

4848
## Analyze hashes file
4949
Send a text file with list of hashes
5050

5151
### Usage
52-
`intezer-analyze analyze-by-list PATH`
52+
`intezer-cli analyze-by-list PATH`
5353

5454
### Parameters
5555
PATH: Path to txt file.
5656

5757
### Example
5858
Send txt file with hashes for analysis:
5959

60-
$ intezer-analyze analyze-by-list ~/files/hashes.txt
60+
$ intezer-cli analyze-by-list ~/files/hashes.txt
6161

62-
For complete documentation please run `intezer-analyze analyze-by-list --help`
62+
For complete documentation please run `intezer-cli analyze-by-list --help`
6363

6464
## Index
6565
Send a file or a directory for indexing
6666

6767
### Usage
68-
`intezer-analyze index PATH INDEX_AS [FAMILY_NAME]`
68+
`intezer-cli index PATH INDEX_AS [FAMILY_NAME]`
6969

7070
### Parameters
7171
PATH: Path to file or directory to index
@@ -77,19 +77,19 @@ FAMILY_NAME: The family name (optional)
7777
### Example
7878
index a single file:
7979

80-
$ intezer-analyze index ~/files/threat.exe.sample malicious family_name
80+
$ intezer-cli index ~/files/threat.exe.sample malicious family_name
8181

8282
index all files in directory:
8383

84-
$ intezer-analyze index ~/files/files-to-index trusted
84+
$ intezer-cli index ~/files/files-to-index trusted
8585

86-
For complete documentation please run `intezer-analyze index --help`
86+
For complete documentation please run `intezer-cli index --help`
8787

8888
## Index hashes file
8989
Send a text file with list of hashes to index
9090

9191
### Usage
92-
`intezer-analyze index-by-list PATH --index-as=INDEX [FAMILY_NAME]`
92+
`intezer-cli index-by-list PATH --index-as=INDEX [FAMILY_NAME]`
9393

9494
### Parameters
9595
PATH: Path to txt file
@@ -101,41 +101,41 @@ FAMILY_NAME: The family name (optional)
101101
### Example
102102
Send a file with hashes and verdict for indexing:
103103

104-
$ intezer-analyze index-by-list ~/files/hashes.txt --index-as=malicious family_name
104+
$ intezer-cli index-by-list ~/files/hashes.txt --index-as=malicious family_name
105105

106-
For complete documentation please run `intezer-analyze index-by-list --help`
106+
For complete documentation please run `intezer-cli index-by-list --help`
107107

108108
## Upload offline endpoint scan
109109
Upload an offline scan created by running the Intezer Endpoint Scanner with '-o' flag
110110

111111
### Usage
112-
`intezer-analyze upload-endpoint-scan OFFLINE_SCAN_DIRECTORY`
112+
`intezer-cli upload-endpoint-scan OFFLINE_SCAN_DIRECTORY`
113113

114114
### Parameters
115115
OFFLINE_SCAN_DIRECTORY: Path to directory with offline endpoint scan results
116116

117117
### Examples:
118118
Upload a directory with offline endpoint scan results:
119119

120-
$ intezer-analyze upload-endpoint-scan /home/user/offline_scans/scan_MYPC_2019-01-01_00-00-00
120+
$ intezer-cli upload-endpoint-scan /home/user/offline_scans/scan_MYPC_2019-01-01_00-00-00
121121

122-
For complete documentation please run `intezer-analyze upload-endpoint-scan --help`
122+
For complete documentation please run `intezer-cli upload-endpoint-scan --help`
123123

124124
## Upload multiple offline endpoint scans
125125
Upload multiple offline scans created by running the Intezer Endpoint Scanner with '-o' flag
126126

127127
### Usage
128-
`intezer-analyze upload-endpoint-scans-in-directory OFFLINE_SCANS_ROOT_DIRECTORY`
128+
`intezer-cli upload-endpoint-scans-in-directory OFFLINE_SCANS_ROOT_DIRECTORY`
129129

130130
### Parameters
131131
OFFLINE_SCANS_ROOT_DIRECTORY: Path to root directory containing offline endpoint scan results
132132

133133
### Examples:
134134
Upload a directory with offline endpoint scan results:
135135

136-
$ intezer-analyze upload-endpoint-scans-in-directory /home/user/offline_scans
136+
$ intezer-cli upload-endpoint-scans-in-directory /home/user/offline_scans
137137

138-
For complete documentation please run `intezer-analyze upload-endpoint-scans-in-directory --help`
138+
For complete documentation please run `intezer-cli upload-endpoint-scans-in-directory --help`
139139

140140
## Upload all subdirectories with .eml files to analyze
141141
Upload a directory with .eml files
@@ -144,8 +144,8 @@ Upload a directory with .eml files
144144
UPLOAD_EMAILS_IN_DIRECTORY: Path to root directory containing the .eml files
145145

146146
### Examples:
147-
$ intezer-analyze upload-emails-in-directory /path/to/emails_root_directory
147+
$ intezer-cli upload-emails-in-directory /path/to/emails_root_directory
148148

149149
# Troubleshooting
150-
The cli produce a log file named `intezer-analyze-cli.log` in the current working directory.
150+
The cli produce a log file named `intezer-cli-cli.log` in the current working directory.
151151
To enable console output, set the environment variable `INTEZER_DEBUG=1`.

0 commit comments

Comments
 (0)