https://github.com/ankushkun/apm-cli

cli tool for ao package manager
https://github.com/ankushkun/apm-cli

ao apm arweave betteridea

Last synced: 6 days ago
JSON representation

cli tool for ao package manager

• Host: GitHub
• URL: https://github.com/ankushkun/apm-cli
• Owner: ankushKun
• Created: 2024-07-25T06:29:48.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-19T07:07:21.000Z (4 months ago)
• Last Synced: 2024-11-30T05:20:35.977Z (about 1 month ago)
• Topics: ao, apm, arweave, betteridea
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/apm-tool
• Size: 726 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# APM CLI TOOL

![Static Badge](https://img.shields.io/badge/apm--tool-a?style=flat&logo=npm&logoColor=red&color=lightgreen&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fapm-tool)

[![downloads](https://img.shields.io/npm/dt/apm-tool?color=lightgreen)](https://www.npmjs.com/package/apm-tool)

[![X Follow](https://img.shields.io/twitter/follow/betteridea_dev)](https://twitter.com/betteridea_dev)

The `apm-tool` is a command line interface for ao package manager to:

- Initialise new package boilerplate

- Register a new vendor name

- Register/Update packages

- Download a package locally

## Installation

```shell

npm i -g apm-tool

```

## Usage

```shell

apm  [arguments]

# or

npx apm-tool  [arguments]

```

## Commands

- `init` - Create a new package boilerplate

- `register-vendor` - Register a new vendor name or package

- `publish` - Publish a new package

- `update` - Update an existing package

- `download` - Download a package locally

- `bundle` - Bundle a package (creates a dist folder that can be uploaded to apm web)

## Interactive Menu

```shell

apm

# or

npx apm-tool

```

This will display an interactive menu with all the different commands that can be used.

![menu](./media/image.png)

### `init`

```shell

apm init

```

Similar to `npm init` this will create a new package boilerplate. It will ask for the following information:

- Vendor name

- Package name

- version

- description

- keywords

- license

- repository

An apm.json file will be created containing all the details of the package to be published

### `register-vendor`

```shell

apm register-vendor

```

Registers a new vendor name for packages to be published in.

### `publish`

```shell

apm publish

```

Reads the apm.json file for package details and publishes the package to the apm registry.

### `download`

```shell

apm download <@vendor/package@version>

```

this will download the package locally in the `apm_modules` directory.

### `bundle`

```shell

apm bundle

```

this will bundle your soruce code and create a dist folder that can be uploaded to apm web.