https://github.com/pigeonposse/sizium
Get the actual size of any local or remote package
https://github.com/pigeonposse/sizium
api cli library package pigeonposse pkg-size pp size
Last synced: 5 months ago
JSON representation
Get the actual size of any local or remote package
- Host: GitHub
- URL: https://github.com/pigeonposse/sizium
- Owner: pigeonposse
- License: gpl-3.0
- Created: 2025-01-11T17:20:23.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-20T12:47:41.000Z (5 months ago)
- Last Synced: 2025-01-27T10:45:14.743Z (5 months ago)
- Topics: api, cli, library, package, pigeonposse, pkg-size, pp, size
- Language: TypeScript
- Homepage: https://sizium.pigeonposse.com
- Size: 2.03 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sizium
[](https://pigeonposse.com)
[](https://pigeonposse.com?popup=about)
[](https://pigeonposse.com/?popup=donate)
[](https://twitter.com/pigeonposse_)
[](https://www.instagram.com/pigeon.posse/)
[](https://medium.com/@pigeonposse)
[](https://sizium.pigeonposse.com)
[](/LICENSE)
[](https://www.npmjs.com/package/sizium)
Get the actual size of any local or remote package
## Table of contents
- [What is `sizium`?](#what-is-sizium)
- [🔑 Installation](#-installation)
- [➕ More](#-more)
- [👨💻 Development](#-development)
- [❤️ Donate](#-donate)
- [📜 License](#-license)
- [✨ About us](#-about-us)
## What is `sizium`?
`sizium` is a **opensource** tool to get the actual size of any local or remote package.
**Library** usage:
```js
import {Sizium} from 'sizium'
// Get size from remote
const pkg = new Sizium('[email protected]')
const data = await pkg.get()
console.log(data.size) // size in bytes
```
```js
import {Sizium} from 'sizium'
// Get size from local
const pkg = new Sizium('./package.json')
const data = await pkg.get()
console.log(data.size) // size in bytes
```
**CLI** usage:
```bash
sizium -i chalk
```
## 🔑 Installation
```bash
npm install @sizium/core
# or
pnpm install @sizium/core
# or
yarn add @sizium/core
# or
bun add @sizium/core
# or
deno add @sizium/core
```
## ➕ More
- 🌞 [Core](https://docs.sizium.pigeonposse.com/guide/core)
- 📖 [Api](https://docs.sizium.pigeonposse.com/guide/api)
- [Api-client](https://docs.sizium.pigeonposse.com/guide/api-client)
- 🔢 [Cli](https://docs.sizium.pigeonposse.com/guide/cli)
- [Lib](https://docs.sizium.pigeonposse.com/guide/lib)
- [Node-server](https://docs.sizium.pigeonposse.com/guide/node-server)
---
## 👨💻 Development
__Sizium__ is an open-source project and its development is open to anyone who wants to participate.
[](https://github.com/pigeonposse/sizium/issues)
[]({{const.pkg.repository.url}}/pulls)
[]({{const.pkg.homepage}})
## ❤️ Donate
Help us to develop more interesting things.
[](https://pigeonposse.com/?popup=donate)
## 📜 License
This software is licensed with __[GPL-3.0](https://github.com/pigeonposse/sizium/blob/main/LICENSE)__.
[](https://github.com/pigeonposse/sizium/blob/main/LICENSE)
## ✨ About us
*PigeonPosse* is a __code development collective__ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.
[](https://github.com/pigeonposse)
---
[](https://pigeonposse.com)
[](https://pigeonposse.com?popup=about)
[](https://pigeonposse.com/?popup=donate)
[](https://twitter.com/pigeonposse_)
[](https://www.instagram.com/pigeon.posse/)
[](https://medium.com/@pigeonposse)