Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aptos-labs/aptos-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Aptos CLI
The @aptos-labs/aptos-cli
package allows you to use the Aptos CLI from inside a Nodejs
project.
Download
To install the Aptos CLI, you need to have Node.js and npm installed on your system. Then, you can install it using:
npm install @aptos-labs/aptos-cli
That command will download the Aptos CLI and create a Node bin file, making it available to use in a Node environment.
Install
Once you have the package installed and the Node bin file, you can run the following command, in your project environment, to install the Aptos CLI in your project:
npx aptos --install
Alternatively, you can simply run the cli using the npx aptos
command. That will install the Aptos CLI in your project if it's not already installed.
npx aptos
Usage
To use the Aptos CLI, in your project environment, run the npx aptos
command, to see the available commands.
npx aptos
Updating the Aptos CLI
To update the Aptos CLI, you can run the following command within your project environment:
npx aptos --update
Development
To set up the project for development:
- Clone the repository
- Install dependencies:
npm install
- Run the development server:
npm run dev
This will build the project and run the CLI.
Building
To build the project:
npm run build