Skip to main content

Command Line Interface for Safe

Project description

PyPI version Build Status Coverage Status Python 3.9 Python 3.10 Python 3.11 Python 3.12 Docker Image Version (latest semver)

Safe CLI

Safe CLI is a command-line utility for Safe contracts. You can use it to manage your Safe account from the command line.

It does not rely on Safe{Core} API and can also be used in networks where Safe services are unavailable. Learn more through the documentation.

Using Docker

Prerequisite: Install Docker Desktop.

Once Docker is installed on your system, run the following command to create new Safe accounts:

docker run -it safeglobal/safe-cli safe-creator

You can also run the following command to run the Safe CLI with an existing Safe:

docker run -it safeglobal/safe-cli safe-cli <checksummed_safe_address> <ethereum_node_url>

Using Python PIP

Prerequisite: Python >= 3.9 (Python 3.12 is recommended).

Once Python is installed on your system, run the following command to install Safe CLI:

pip3 install -U safe-cli

Usage

safe-cli [-h] [--history] [--get-safes-from-owner] address node_url

positional arguments:
  address                The address of the Safe, or an owner address if --get-safes-from-owner is specified.
  node_url               Ethereum node url

options:
  -h, --help             Show this help message and exit
  --history              Enable history. By default it's disabled due to security reasons
  --get-safes-from-owner Indicates that address is an owner (Safe Transaction Service is required for this feature)

Safe{Core} API/Protocol

Setting up for developing

If you miss something and want to send us a PR:

git clone https://github.com/safe-global/safe-cli.git
cd safe-cli
stat venv 2>/dev/null || python3 -m venv venv
source venv/bin/activate && pip install -r requirements-dev.txt
pre-commit install -f

Contributors

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

safe_cli-1.1.0.tar.gz (56.0 kB view details)

Uploaded Source

Built Distribution

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

safe_cli-1.1.0-py3-none-any.whl (70.5 kB view details)

Uploaded Python 3

File details

Details for the file safe_cli-1.1.0.tar.gz.

File metadata

  • Download URL: safe_cli-1.1.0.tar.gz
  • Upload date:
  • Size: 56.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.14

File hashes

Hashes for safe_cli-1.1.0.tar.gz
Algorithm Hash digest
SHA256 a40e3c79b71956cdac13a38aa7d3a885fffd412015ba1a6d9b484c2ed0f498ac
MD5 c8af6325e9386a4f2b92c5bd27ba35ba
BLAKE2b-256 aa9d6109c230a00476bc3ea1d5b6b084a1f6bada616e53138720c43c9c2cd847

See more details on using hashes here.

File details

Details for the file safe_cli-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: safe_cli-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 70.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.14

File hashes

Hashes for safe_cli-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1dfd95d1a363374bed682652ea1335033bc5f856652955b2378e8b03228d6122
MD5 6d0f9e2a5cb5b5a71f75d896a3d7da4f
BLAKE2b-256 802a5a4e23aac9fa54858db48bc427238ea529abbf579724ecb4a0b2329366b7

See more details on using hashes here.

Supported by

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