Skip to main content

Image

Work with PT Sandbox like a pro


Documentation: https://security-experts-community.github.io/sandbox-cli

Source Code: https://github.com/Security-Experts-Community/sandbox-cli


[!NOTE] python >= 3.11 is required.

Installation

Using pipx:

pipx install sandbox-cli

Using PyPi:

pip install sandbox-cli

NixOS:

nix shell 'github:Security-Experts-Community/sandbox-cli'

Config

You must create default config file as described in docs/config-examples/config.toml:

Linux/MacOS:

~/.config/sandbox-cli/config.toml
or
$XDG_HOME_CONFIG_HOME/sandbox-cli/config.toml

Windows:

%APPDATA%\sandbox-cli\config.toml

Available options

  • scanner - Scan with the sandbox.
  • images - Get available images in the sandbox.
  • download - Download any artifact from the sandbox.
  • email - Upload an email and get its headers.
  • report - Generate short report from sandbox scans.
  • unpack/conv - Convert sandbox logs into an analysis-friendly format.
  • rules - Working with raw sandbox rules.

Usage examples

images

Get all availables images:

sandbox-cli images
┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓
┃ Name                   ID                       Version     Product version ┃
┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩
│ altlinux               altworkstation-10-x64    ...         ...             │
│ astra                  astralinux-smolensk-x64  ...         ...             │
│ redos                  redos-murom-x64          ...         ...             │
│ ubuntu                 ubuntu-jammy-x64         ...         ...             │
│ Windows 10 Pro         win10-1803-x64           ...         ...             │
│ Windows 10 Enterprise  win10-22H2-x64           ...         ...             │
│ Windows 10 Pro         win11-23H2-x64           ...         ...             │
│ Windows 7 Enterprise   win7-sp1-x64             ...         ...             │
│ Windows 7 Enterprise   win7-sp1-x64-ics         ...         ...             │
└───────────────────────┴─────────────────────────┴────────────┴─────────────────┘

scanner

Scan the file on all available windows images with timeout 60s and with automatic logs unpacking:

sandbox-cli scanner scan-new -i windows -t 60 -U malware.exe

Development

uv is used to build the project.

uv sync

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sandbox_cli-0.2.50.tar.gz (35.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sandbox_cli-0.2.50-py3-none-any.whl (49.8 kB view details)

Uploaded Python 3

File details

Details for the file sandbox_cli-0.2.50.tar.gz.

File metadata

  • Download URL: sandbox_cli-0.2.50.tar.gz
  • Upload date:
  • Size: 35.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.14

File hashes

Hashes for sandbox_cli-0.2.50.tar.gz
Algorithm Hash digest
SHA256 fac736d6ed6571ae4fdfe9ad52edf0ee409a8aae263108b3736bd0de5308610d
MD5 705d8dd6e5b8daee3ed358fcecc49806
BLAKE2b-256 c97a1a2217653ef4715effff7da6710e5145d46f3ea9f2f267391b633452a871

See more details on using hashes here.

File details

Details for the file sandbox_cli-0.2.50-py3-none-any.whl.

File metadata

  • Download URL: sandbox_cli-0.2.50-py3-none-any.whl
  • Upload date:
  • Size: 49.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.14

File hashes

Hashes for sandbox_cli-0.2.50-py3-none-any.whl
Algorithm Hash digest
SHA256 c10c8b6169a92bdb31de566208a800ab342a8ec04cb39cb653c343166a7b5ff9
MD5 d16cdbe47531d3541abf37faaf1aa99a
BLAKE2b-256 d0a2c52c390c3c64e129d9851c649507eb967c95e460c62479e9833dd4324776

See more details on using hashes here.

Release history Release notifications | RSS feed

0.3.1

2 files

0.3.0

2 files

This release

0.2.50 This release

2 files

0.2.49

2 files

0.2.48

2 files

0.2.47

2 files

0.2.46

2 files

0.2.45

2 files

0.2.44

2 files

0.2.43

2 files

0.2.42

2 files

0.2.41

2 files

0.2.40

2 files

0.2.39

2 files

0.2.38

2 files

0.2.37

2 files

0.2.36

2 files

0.2.35

2 files

0.2.34

2 files

0.2.33

2 files

0.2.32

2 files

0.2.31

2 files

0.2.30

2 files

0.2.29

2 files

0.2.28

2 files

0.2.27

2 files

0.2.26

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page