CLI
Overview of the SettleMint CLI
The SettleMint CLI (Command-Line Interface) is a robust tool crafted to enhance interaction with the SettleMint blockchain platform directly from your terminal. It enables developers, administrators, and blockchain enthusiasts to efficiently manage blockchain networks, deploy smart contracts, and configure infrastructure without relying on a graphical interface. Designed for versatility, the CLI supports integration with popular package managers like npm, Yarn, Bun, and pnpm, offering both local and global installation options, as well as automation capabilities through GitHub Actions.
Core functionality
The SettleMint CLI (@settlemint/sdk-cli) is a command-line interface
designed to simplify blockchain development and infrastructure management. It
enables developers to:
Manage blockchain projects
Deploy and test smart contracts
Configure infrastructure and nodes
Generate TypeScript code for dApp development
The CLI supports multiple package managers (npm, Yarn, Bun, pnpm) and integrates with GitHub Actions, providing automation for CI/CD workflows.
TIP: To verify installation, run
SettleMint --versionafter setup.
Core functionality
The SettleMint CLI provides a rich set of commands to streamline blockchain tasks. Below is an overview of key commands:
| Command | Description |
|---|---|
settlemint --version | Displays the installed CLI version. |
settlemint --help | Shows available commands and subcommands. |
settlemint login | Authenticates with SettleMint using a Personal Access Token (PAT). |
settlemint create --project-name <name> --template <template> | Initializes a new project from a template. |
settlemint scs hardhat deploy remote --accept-defaults | Deploys smart contracts remotely using Hardhat. |
settlemint scs subgraph deploy --accept-defaults <subgraph-name> | Deploys a subgraph for blockchain data indexing. |
settlemint codegen | Generates TypeScript code for dApp integrations. |
npm run dev (or bun run dev, etc.) | Starts your dApp in development mode. |
settlemint scs create --project-name <name> --use-case <use-case> | Creates a project from a smart contract template. |
settlemint scs foundry test | Runs smart contract tests using Foundry. |
NOTE: Many commands support additional flags (e.g.,
--accept-defaults). Use--helpfor more details (settlemint create --help).
Installation
The CLI can be installed globally or as a project dependency:
Global installation
npm install -g @settlemint/sdk-cli
With a hierarchical command structure and detailed help options (e.g.,
SettleMint --help), the CLI ensures intuitive navigation through every task.
The SettleMint CLI transforms blockchain development by offering:
- Increased Productivity: Simplifies complex operations into concise commands, reducing manual effort.
- Workflow Flexibility: Adapts to diverse setups with support for multiple package managers and installation methods.
- Automation Support: Enhances CI/CD pipelines through GitHub Actions integration.
- Precision and Control: Provides granular command options for managing smart contracts, subgraphs, and infrastructure.
- Time Efficiency: Speeds up development with templates and automated code generation, allowing focus on innovation.
This tool caters to everyone from individual developers to enterprise teams, making blockchain technology more approachable and effective.
Additional resources
For in-depth guidance and setup details, explore these official SettleMint resources:
- SettleMint Developer Hub: Access the full API Reference and command documentation at SettleMint’s console.
- npm Package Page: Review the CLI package details and installation instructions on npmjs.com/@settlemint/sdk-cli.
- GitHub README: Dive into the source code and comprehensive usage guide at github.com/settlemint/sdk/cli/README.md.
- Contributing Opportunities: Learn how to contribute to the CLI via the SettleMint GitHub page.
Getting started
To begin, install the SettleMint CLI globally with
npm install -g @settlemint/sdk-cli (or use your preferred package manager),
then confirm the installation with SettleMint --version. Unlock the potential
of blockchain development with a tool engineered for speed, security, and
simplicity.
Licensed under the FSL Software License. See the LICENSE file for details.