Skip to content

What is sizium?

sizium is a opensource tool to get the actual size of any local or remote package.

help

Usage

You can use the full Sizium by installing the sizium library or you can use only the parts you need to get better performance.

Library

Core Library

Use in your JavaScript or TypeScript project.

bash
npm install @sizium/core
bash
pnpm install @sizium/core
bash
yarn add @sizium/core
bash
bun add @sizium/core
bash
deno add @sizium/core
js
import {
Sizium
} from '@sizium/core'
const
pkg
= new
Sizium
('[email protected]')
const
data
= await
pkg
.
get
()
console
.
log
(
data
)

CLI

Use the Command line Interface in your system.

bash
npm install @sizium/cli
bash
pnpm install @sizium/cli
bash
yarn add @sizium/cli
bash
bun add @sizium/cli
bash
deno add @sizium/cli
bash
sizium -i chalk

REST API

You can implement the API wherever you want and even extend it if you wish.

The API is built with backan, which is a wrapper for hono, meaning that hono instructions can be used to implement the API wherever you want.

bash
npm install @sizium/api
bash
pnpm install @sizium/api
bash
yarn add @sizium/api
bash
bun add @sizium/api
bash
deno add @sizium/api

Node server

We have a package that already has the API on a Node.js server. Below is an example of its use.

bash
npm install @sizium/node-server
bash
pnpm install @sizium/node-server
bash
yarn add @sizium/node-server
bash
bun add @sizium/node-server
bash
deno add @sizium/node-server
bash
sizium-server --port 1312
bash
curl http://localhost:1312/size?input=bepp

Executables

You can use sizium as a standalone executable for your OS.

This is perfect if you want to use it outside of a Javascript environment.

Available for x64 and arm64 architectures