What is sizium
?
sizium
is a opensource tool to get the actual size of any local or remote package.
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.
npm install @sizium/core
pnpm install @sizium/core
yarn add @sizium/core
bun add @sizium/core
deno add @sizium/core
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.
npm install @sizium/cli
pnpm install @sizium/cli
yarn add @sizium/cli
bun add @sizium/cli
deno add @sizium/cli
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.
npm install @sizium/api
pnpm install @sizium/api
yarn add @sizium/api
bun add @sizium/api
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.
npm install @sizium/node-server
pnpm install @sizium/node-server
yarn add @sizium/node-server
bun add @sizium/node-server
deno add @sizium/node-server
sizium-server --port 1312
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
andarm64
architectures