update

Author: ayoubfaouzi

.gitignore

@@ -16,9 +16,6 @@ __debug_bin
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
-# Dependency directories (remove the comment below to include it)
-# vendor/
-
 # Go workspace file
 go.work
 

README.md

@@ -1,82 +1,64 @@
 # saferwall-cli
 
-A CLI tool to interact with Saferwall.com to download samples, scan or re-scan new samples.
+A CLI tool to interact with Saferwall.com to scan, rescan and download malware samples.
 
 ## Install
 
 You can either download pre-built binaries or build the tool yourself.
 
 ```sh
-go install github.com/saferwall/cli
+go install github.com/saferwall/cli@latest
 ```
 
+## Getting Started
 
-## Usage
-
-To use the CLI tool you need a [Saferwall](https://saferwall.com) account in order to authenticate yourself.
-
-Use the `config.example.toml` as a reference to reference your credendials. The file should be located in:
-``~/.config/saferwall/config.toml`:
-
-```toml
-[credentials]
-# The URL used to interact with saferwall APIs.
-url = "https://api.saferwall.com"
-# The user name you choose when you sign-up for saferwall.com.
-username = "YourUsername"
-# The password you choose when you sign-up for saferwall.com.
-password = "YourPassword"
-```
-
-The CLI app can also be used to interfact with a self-hosted deployment.
+To use the CLI you need a [Saferwall](https://saferwall.com) account. Run the `init` command to interactively set up your credentials:
 
 ```sh
-saferwall-cli - Saferwall command line tool
+saferwall-cli init
+```
 
-	███████╗ █████╗ ███████╗███████╗██████╗ ██╗    ██╗ █████╗ ██╗     ██╗          ██████╗██╗     ██╗
-	██╔════╝██╔══██╗██╔════╝██╔════╝██╔══██╗██║    ██║██╔══██╗██║     ██║         ██╔════╝██║     ██║
-	███████╗███████║█████╗  █████╗  ██████╔╝██║ █╗ ██║███████║██║     ██║         ██║     ██║     ██║
-	╚════██║██╔══██║██╔══╝  ██╔══╝  ██╔══██╗██║███╗██║██╔══██║██║     ██║         ██║     ██║     ██║
-	███████║██║  ██║██║     ███████╗██║  ██║╚███╔███╔╝██║  ██║███████╗███████╗    ╚██████╗███████╗██║
-	╚══════╝╚═╝  ╚═╝╚═╝     ╚══════╝╚═╝  ╚═╝ ╚══╝╚══╝ ╚═╝  ╚═╝╚══════╝╚══════╝     ╚═════╝╚══════╝╚═╝
+This launches an interactive prompt that asks for:
+- **URL** — the Saferwall API endpoint (defaults to `https://api.saferwall.com`)
+- **Username** — your Saferwall account username
+- **Password** — your Saferwall account password
 
+The credentials are saved to `~/.config/saferwall/config.toml`. To reconfigure, delete that file and run `init` again.
 
-saferwall-cli allows you to interact with the saferwall API. You can
-upload, scan samples from your drive, or download samples.
-For more details see the github repo at https://github.com/saferwall
+The CLI can also be used with a self-hosted Saferwall deployment by providing your own API URL during init.
 
-Usage:
-  saferwall-cli [flags]
-  saferwall-cli [command]
+## Usage
 
+```
 Available Commands:
-  completion  Generate the autocompletion script for the specified shell
-  delete      Delete a sample(s) given its SHA256 hash.
-  download    Download a sample(s) or a behavior report
-  help        Help about any command
-  list        List users or files.
-  rescan      Rescan an exiting file using its hash
-  scan        Submit a scan request of a file using its hash
-  souk        Populate malware-souk database.
-  upload      Upload samples directly to object storage.
+  init        Configure saferwall CLI credentials
+  scan        Upload and scan files
+  rescan      Rescan an existing file using its hash
+  download    Download a sample or a behavior report
+  souk        Populate malware-souk database
   version     Version number
+```
+
+### Scan
+
+Upload and scan files. Supports scanning a single file or an entire directory.
 
-Flags:
-  -h, --help   help for saferwall-cli
+```sh
+saferwall-cli scan -p /path/to/sample
 ```
 
-### Download
+### Rescan
 
-You can download files using their SHA256 hash and specify an output folder, you can also download a batch of samples by copying their SHA256 hash to the clipboard.
+Rescan an existing file by its SHA256 hash, or rescan a batch of hashes from a text file.
 
 ```sh
-cli download --hash 0001cb47c8277e44a09543291d95559886b9c2da195bd78fdf108775ac91ac53
+saferwall-cli rescan <sha256>
 ```
 
-### Scan
+### Download
 
-You can scan or rescan files using the scan command.
+Download files by their SHA256 hash. You can also download a batch of samples from a text file.
 
 ```sh
-cli scan -p /samples/0001cb47c8277e44a09543291d95559886b9c2da195bd78fdf108775ac91ac53
+saferwall-cli download --hash <sha256>
 ```