The Abstract CLI is a command-line tool for working with AbstractSDK apps and modules.
npm i -g @abstract-money/cli
abstract <command> [options]
Try it out:
abstract --help
Commands | Description | Options |
---|---|---|
generate |
generate code based on configuration | -c, --config : path to config file |
init |
create configuration file |
Option | Shorthand | Description |
---|---|---|
--help |
-h |
Display Help |
--version |
-v |
Display version number |
abstract init
This will generate an abstract.config.js
in your project root. You can configure accordingly.
import { defineConfig } from '@abstract-money/cli'
import { react, registry } from '@abstract-money/cli/plugins'
export default defineConfig({
out: 'src/generated', // Relative path from project root of the generated output.
plugins: [
react(),
registry({
contracts: [
{
name: 'app-name', // Your App Name.
namespace: 'abstract', // To claim a namespace on mainnet, please get in touch with Abstract Team.
version: '0.1.0',
},
],
}),
],
})
You need to also install @abstract-money/cli/plugins
:
pnpm install @abstract-money/cli/plugins
You can use npm
or yarn
as per your preference.
Once done, you're ready to generate the code:
abstract generate
You can use additional options as mentioned above. You should get an output like:
❯ abstract generate
✔ Validating plugins
✔ Resolving contracts
✔ Validating contracts
✔ Running plugins
✔ Writing to src/generated/index.ts
And you should be all set to use the types generated directly into your codebase.