Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pawanpaudel93/create-ao-contract
Create AO Contract CLI
https://github.com/pawanpaudel93/create-ao-contract
ao arweave cli decentralized-storage smart-contracts
Last synced: about 1 month ago
JSON representation
Create AO Contract CLI
- Host: GitHub
- URL: https://github.com/pawanpaudel93/create-ao-contract
- Owner: pawanpaudel93
- License: mit
- Created: 2024-05-12T17:59:47.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-24T08:51:13.000Z (4 months ago)
- Last Synced: 2024-10-31T15:53:07.066Z (about 2 months ago)
- Topics: ao, arweave, cli, decentralized-storage, smart-contracts
- Language: Lua
- Homepage: https://npmjs.com/package/create-ao-contract
- Size: 250 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Create AO Contract
A CLI tool for scaffolding AO contracts, featuring [Busted](https://luarocks.org/modules/lunarmodules/busted) for testing and seamless deployment via [ao-deploy](https://github.com/pawanpaudel93/ao-deploy).
## Table of Contents
- [Usage](#usage)
- [Interactive Mode](#interactive)
- [npm](#npm)
- [yarn](#yarn)
- [pnpm](#pnpm)
- [bun](#bun)
- [Non-interactive Mode](#non-interactive)
- [Options](#options)
- [Example Commands](#example-commands)
- [Credits](#credits)
- [License](#license)
## Usage
### Interactive
To scaffold an AO contract interactively, run the following command based on your package manager of choice:
#### npm
```bash
npx create-ao-contract@latest
# or
npm create ao-contract@latest
```
#### yarn
```bash
yarn create ao-contract
```
#### pnpm
```bash
pnpm create ao-contract@latest
```
#### bun
```bash
bunx create-ao-contract@latest
# or
bun create ao-contract@latest
```
During the interactive setup, you'll be prompted for your project's name and other configuration options. Provide your choices to create a new AO contract.
> **Note:** For windows users using a secure shell, ensure your ssh-agent is running as expected for successfull installation of dependencies.
### Non-interactive
For a non-interactive setup, use command line arguments. You can view available options with:
```bash
create-ao-contract --help
```
#### Options
```bash
Usage: create-ao-contract [dir] [options]
A CLI for creating an AO contract
Arguments:
dir The name of the contract, as well as the name of the directory to create
Options:
--noGit Explicitely tell the CLI to not initialize a new git repo in the project (default: false)
--noInstall Explicitely tell the CLI to not run the package manager's install command (default: false)
-y, --default Bypass the CLI and Use default options to bootstrap a new AO contract. Note: Default options can be overridden by user-provided options.
(default: false)
-v, --version Display the version number
-h, --help display help for command
```
#### Example Commands
Quickly scaffold an AO contract using the CLI with the default options by running:
```bash
npx create-ao-contract@latest -y
# or
yarn create ao-contract -y
# or
pnpm create ao-contract@latest -y
# or
bunx create-ao-contract@latest -y
```
Override the default options by passing other options:
```bash
npx create-ao-contract@latest my-ao-contract --noGit --default
# or
yarn create ao-contract my-ao-contract --noGit --default
# or
pnpm create ao-contract@latest my-ao-contract --noGit --default
# or
bunx create-ao-contract@latest my-ao-contract --noGit --default
```
## Credits
For a complete list of contributors and credits, please see the [CREDITS](https://github.com/pawanpaudel93/create-ao-contract/blob/main/CREDITS.md) file.
## License
This project is licensed under the [MIT License](https://github.com/pawanpaudel93/create-ao-contract/blob/main/LICENSE).