The Gridlock CLI is your command-line interface to the Gridlock Network. It provides a simple way to interact with the network, manage your guardians, and handle your crypto assets securely.
The CLI works in conjunction with the Orchestration Node and Guardian Nodes to provide a complete, secure crypto management solution.
To understand how the full system works, see System Overview.
Related: Orch Node | Guardian Node | SDK
- Start the Gridlock network infrastructure:
docker network create gridlock-net
docker compose upThis will start:
- The orchestration node (http://localhost:5310)
- Three guardian nodes
- The database (MongoDB)
- The peer-to-peer networking layer
- In a new terminal, install and run the CLI:
npm install -g .
gridlock run-exampleReview the logs from the first terminal for guardian output.
For detailed customization options, local development setup, and advanced configuration, see Customization and Development Guide.
This code is yours to use — but it's even better when you're part of the official Gridlock network.
By running guardian nodes, you can earn rewards while helping secure the network.
Join the community: gridlock.network/join