Getting Started

Welcome to the Acme documentation. This guide will walk you through everything you need to know to get up and running quickly.

Installation

Acme is available via npm. Node.js 24 or later is required.

Via npm

Install the package into your project:

npm install acme

Via CDN

For quick prototyping you can load Acme directly from a CDN:

<script src="https://cdn.example.com/acme@latest/dist/acme.js"></script>

Configuration

Create an acme.config.js file in your project root. All options are optional — Acme works out of the box with sensible defaults.

export default {
  output: 'dist/',
  minify: true,
  sourcemaps: false,
  plugins: [],
};

Configuration options

Usage

Basic example

Import Acme and call build() to compile your project:

import acme from 'acme';

const result = await acme.build({
  entry: 'src/index.js',
  output: 'dist/',
});

console.log(`Built ${result.files.length} files`);

CLI

Acme also ships a CLI for use in npm scripts or CI pipelines:

# Build once
npx acme build

# Watch mode
npx acme build --watch

Notes

• Entry files must be valid ES modules
• Output paths are relative to the project root
• Use Ctrl+C to stop watch mode

Keep your entry points small. Let the bundler do the tree-shaking rather than manually managing imports. Acme Best Practices Guide

API Reference

acme.build(options)

Compiles your project and writes output to disk.

Returns a Promise<BuildResult>.

Parameters

acme.watch(options)

Starts a file watcher and rebuilds on changes.

const watcher = await acme.watch({ entry: 'src/index.js' });

for await (const event of watcher) {
  console.log('Rebuilt after change in ' + event.file);
}

// Stop watching
await watcher.close();

Changelog

v2.0.0 Latest

• Rewritten core pipeline for 40% faster builds
• New plugin API — see API Reference
• Node.js 24 required

v1.1.0

• Added watch() API
• Improved error messages with source locations
• Fixed sourcemap generation on Windows

v1.0.0 Stable

• Initial release

FAQ