Skip to main content

RESTful client for CrackQ

Project description

CrackQ_client: REST API client for CrackQ


git clone

cd ./crackq_client

pip3 install .

Or install from PyPi with:

pip3 install crackq_client

This will install the package, providing the client ('crackq') in your path.


To use the queue a Python client is provided.

Authentication is performed using a JSON post.

Some example uses are outlined below:



crackq --url -l --user test --passwd test

or enter the password securely with a prompt:

crackq --url -l --user test


crackq --url -L


view available Hashcat options (rules, wordlists, hash modes etc):

crackq --url -o

query the queue:

crackq --url -q

query failed queue:

crackq --url -f

get details for a job:

crackq --url -j --job_id f210b58b7a214d33813051a550cbf3e4

query complete queue:

crackq --url -c


add jobs:


crackq -a --attack_mode 0 --hash_mode 1000 --hash_file deadbeef.hashes --wordlist tw_leaks --url --rules d3ad0ne --name dt_test_nt_twl_d3ad

brute force:

crackq -a --attack_mode 3 --hash_mode 1000 --hash_file deadbeef.hashes --mask ?u?a?a?l?l?l?a?a --url --name dt_test_nt_brute

stop/pause a job:

crackq --url -s --job_id <job_id uuid>

stop/delete a job:

crackq --url -d --job_id <job_id uuid>

restore a job:

crackq --url -r --job_id <job_id uuid>

Project details

Download files

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

Source Distribution

crackq_client-0.0.1.tar.gz (5.3 kB view hashes)

Uploaded source

Built Distribution

crackq_client-0.0.1-py3-none-any.whl (7.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page