!logo.png

VCPM - Voxel Core Project Manager

CLI util for managing voxel core content packs, with vcpm we can start
new project and build it for release


- Installation
- Usage
- Commands
- Roadmap
- Support Shells
- Support OS

Installation

$3

``bash
npm i -g vcpm
`

$3

You can install vcpm with installer for your OS, find it in latest release
Watch here

Standalone tarballs can be found in latest release Watch here

Usage

$3

`Bash
vcpm COMMAND
`

$3

`Bash
vcpm --version | -v
`

$3

`Bash
vcpm COMMAND --help
`

Commands

- vcpm build
- vcpm autocomplete

$3

Build project

`Bash
USAGE
$ vcpm build [-d]

FLAGS
-d, --dev build in development mode

DESCRIPTION
build project
`

_See code: src/commands/build/index.ts_

$3

Display autocomplete installation instructions.

`Bash
USAGE
$ vcpm autocomplete [SHELL] [-r]

ARGUMENTS
[SHELL] (zsh|bash|powershell) Shell type

FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)

DESCRIPTION
Display autocomplete installation instructions.

EXAMPLES
$ vcpm autocomplete

$ vcpm autocomplete bash

$ vcpm autocomplete zsh

$ vcpm autocomplete powershell

$ vcpm autocomplete --refresh-cache
``

Roadmap

$3

- [ ] Package management function
- [ ] Create new project command
- [ ] More features coming soon
- [ ] Project Website

$3

- [x] Made standalone verison
- [x] Building project for production and development
- [x] Autocomplete for crossplaforms

Support Shells

- [x] Bash
- [x] Zsh
- [x] Powershell 7+
- [x] Fish (Without Autocomplete)
- [x] CMD (Without Autocomplete)
- [x] Powershell < 7 (Without Autocomplete)

Support OS

$3

- Windows 11 ❓ - 0.2.2 (need update)

$3

- Arch Linux ✅ - 0.4.0

$3

No tests on MacOS