siphon-cli

library0.0.8jsnpmunverified

Siphon is a lightweight CLI bundler for web applications that processes HTML documents and resolves their assets (JS, CSS, images) into optimized production builds. At version 0.0.8, it is in early development with basic bundling and watch mode. It differentiates itself with zero configuration for simple projects, using a siphon.config.js for customization. Compared to Webpack or Parcel, it is minimal and opinionated, focusing on HTML-first bundling. The package is installable globally and intended for small to medium projects. However, given its early stage, it lacks advanced features like code splitting or tree shaking and may have limited community support.

devops

npm install siphon-cli

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SIPHON-CLI

siphon-cli

devopsjavascriptv0.0.8

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

siphon

✓ siphon-cli -bundle index.html

✗ siphon -bundle index.html

The binary is invoked as 'siphon-cli', not 'siphon', because the package name includes '-cli'. Ensure global install or use npx.

siphon.config.js

✓ module.exports = { outDir: './dist' }

✗ export default { outDir: './dist' }

Configuration uses CommonJS (require/module.exports) not ESM, as the package is Node.js-based and does not support .mjs or ES modules in config.

watch mode

✓ siphon-cli -bundle --w

✗ siphon-cli --watch

The watch flag is '-w' or '--w', not '--watch'. It expects the base file to be src/index.html by default.

Installs Siphon CLI globally, creates a minimal web project with HTML, CSS, and JS files, and bundles them into a single HTML file in the 'build' directory.

// Install globally npm install -g siphon-cli // Create a simple project with index.html mkdir my-project && cd my-project echo '<!DOCTYPE html><html><head><link rel="stylesheet" href="style.css"></head><body><h1>Hello</h1><script src="app.js"></script></body></html>' > index.html echo 'body { background: #fff; }' > style.css echo 'console.log("Hello")' > app.js // Bundle using default settings siphon-cli -bundle index.html // Output is in ./build/index.html cat build/index.html

Debug

Known issues

breakingVersion 0.0.x is unstable. API and CLI flags may change without notice.

fix

Pin version in package.json or use a specific version; check changelog before upgrading.

affects: 0.0.x

gotchaDefault watch mode assumes base file is src/index.html. If you use a different path, it may not work as expected.

fix

Always specify the base file explicitly: 'siphon-cli -bundle index.html --w'.

affects: >=0.0.1

gotchaConfiguration must be CommonJS (module.exports). Using ESM (export default) will cause a silent fallback to defaults.

fix

Use 'module.exports = { ... }' in siphon.config.js.

affects: >=0.0.1

gotchaThe CLI command is 'siphon-cli' not 'siphon' after global install, which may cause confusion.

fix

Run 'siphon-cli' or use npx: 'npx siphon-cli -bundle index.html'.

affects: >=0.0.1

deprecatedThe bundler does not support code splitting or lazy loading; all assets are inlined or concatenated.

fix

For larger apps, consider Webpack, Rollup, or Parcel.

affects: <=0.0.8

Errors

Common errors & fixes

siphon-cli: command not found

Global install failed or PATH not updated.

fix

Run 'npm install -g siphon-cli' and ensure npm global bin directory is in PATH (e.g., on Unix: export PATH=$PATH:$(npm bin -g)).

TypeError: siphon is not a function

Attempting to require('siphon-cli') as a programmatic API; the package is CLI-only.

fix

Use the CLI directly via 'siphon-cli -bundle index.html' instead of importing in Node.js.

ENOENT: no such file or directory, open 'src/index.html'

Watch mode defaults to 'src/index.html' but the file does not exist.

fix

Specify the correct path: 'siphon-cli -bundle ./index.html --w'

Upgrade

Version history

0.0.8latest on npm

Audit

Dependencies

acornrequiredJavaScript parsing used during bundling.

Agent activity

7 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/adebola-xyz/siphon ↗

packagesiphon-cli ↗

homepagehttps://github.com/adebola-xyz/siphon#readme ↗