aral-vps-test CLI

1.0.34 · active · verified Sun Apr 19

aral-vps-test is an oclif-powered command-line interface (CLI) tool designed for managing virtual private server (VPS) environments, particularly for creating, listing, starting, and updating workspaces. It provides commands for system-level operations like `init`, `start`, and `destroyAll`, as well as specific workspace management functions such as `workspace:create` and `workspace:list`. The package is currently at version 1.0.34 and primarily serves as a utility for developers and system administrators to automate VPS provisioning and deployment tasks. It is built with TypeScript, offering type declarations, and its release cadence follows a typical npm package update cycle as needed for feature enhancements or bug fixes. Its key differentiator is simplifying the lifecycle management of multiple repository branches as 'workspaces' on a VPS.

Common errors

```
aral: command not found
```
cause The `aral-vps-test` package was not installed globally, or the global npm bin directory is not in your system's PATH.

fix Run `npm install -g aral-vps-test` to install the CLI globally. If the issue persists, ensure your shell's PATH includes the directory where global npm binaries are installed (e.g., `$(npm root -g)/../.bin`).
```
Error: EACCES: permission denied, access 'config-file-path'
```
cause The CLI is attempting to write to or read from a configuration file without sufficient file system permissions.

fix Ensure the user running the `aral` command has appropriate read/write permissions for the configuration directory and files. You may need to use `sudo` for initial setup or adjust directory permissions (e.g., `sudo chown -R $(whoami) /usr/local/lib/node_modules` for global installs if permissions are wrong, though this needs caution).
```
Configuration file not found. Please run `aral init` first.
```
cause Many `aral` commands depend on an initial configuration, which is set up via the `init` command.

fix Execute `aral init` to go through the interactive configuration wizard and set up the necessary environment files before running other commands.

Warnings

gotcha The `aral destroyAll` command performs a destructive action, removing all system containers. It explicitly states that after execution, `authorized_keys` for the Webhook container will need to be re-set.
Fix: Exercise extreme caution when using `aral destroyAll`. Ensure backups are in place and be prepared to reconfigure necessary system components manually after execution.
gotcha As an oclif CLI, this tool relies on Node.js being installed and accessible in the system's PATH. Ensure your Node.js version meets the `engines` requirement ( `>=8.0.0` ) for stable operation.
Fix: Verify Node.js is installed and correctly configured in your PATH. Use a Node.js version manager (e.g., nvm) to manage different Node.js versions and switch if necessary.

Install

npm install aral-vps-test npm
yarn add aral-vps-test yarn
pnpm add aral-vps-test pnpm

Imports

DestroyAll
wrong:
```
const DestroyAll = require('aral-vps-test/lib/commands/destroyAll');
```
correct:
```
import DestroyAll from 'aral-vps-test/lib/commands/destroyAll';
```
This imports the 'DestroyAll' oclif Command class for advanced programmatic use (e.g., testing or extending the CLI), not for general application library consumption. The CLI is primarily used via global installation and command-line execution.
Init
wrong:
```
const Init = require('aral-vps-test/lib/commands/init');
```
correct:
```
import Init from 'aral-vps-test/lib/commands/init';
```
Imports the 'Init' oclif Command class. Direct programmatic import of CLI commands is an advanced use case and generally discouraged in favor of calling the CLI executable or extracting shared logic into separate modules.
WorkspaceCreate
wrong:
```
const WorkspaceCreate = require('aral-vps-test/lib/commands/workspace/create');
```
correct:
```
import WorkspaceCreate from 'aral-vps-test/lib/commands/workspace/create';
```
Imports the 'WorkspaceCreate' oclif Command class. For most users, interacting with the `aral` CLI via the terminal is the intended method, rather than programmatic imports of individual command implementations.

Quickstart

Demonstrates global installation, initialization, starting the system, and creating a new workspace using the `aral` CLI.

npm install -g aral-vps-test

aral init
# Follow the interactive configuration wizard.

aral start
# Starts the system based on your configuration.

aral workspace:create my-repo main github
# Creates a workspace for 'my-repo' from the 'main' branch on GitHub.

view raw JSON →