Skip to content

Latest commit

 

History

History
152 lines (105 loc) · 2.85 KB

README.md

File metadata and controls

152 lines (105 loc) · 2.85 KB
Raw

Elebox

🌐中文

Lightweight personal electronic parts inventory management tool.

It aims to remain simple, intuitive, zero configuration and works out-of-the-box. The embedded, single-file database is easy to backup.

🚧 In development

Features

  • Category tree
  • Custom fields
  • YAML export and import
  • i18n internationalization (🚧)
  • Part field:
    • Name
    • Category
    • Quantity
    • Package
    • Package detail
    • Manufacturer
    • Manufacturer part number
    • Alias
    • Location
    • Product link
    • Datasheet link
    • Image link
    • Description
    • Starred
    • n× Custom fields
      • Type
      • Name
      • Value
    • n× Suppliers
      • Name
      • Link
      • Price
      • Note

More screenshot

Usage

Download executable from Releases.

GUI

GUI powered by Tauri.

For development, install Node.js >= 20.9.0 for Vite.

cd elebox-tauri
pnpm install
pnpm tauri dev

CLI

If you're run via Cargo (i.e. not using the released executable), replace elebox-cli with cargo run -p elebox-cli -- in the following command. For example, use cargo run -p elebox-cli -- help instead of elebox-cli help.

Basic

Print help message:

elebox-cli help

Use and operate on the default database path and filename ./elebox.db:

elebox-cli <COMMAND>

or a specified ./my_box.db:

elebox-cli my_box.db <COMMAND>

where <COMMAND> can be init, part, category, export or import.

Init

You need to initialize a database before you can proceed with the next steps.

Create and initialize a new database with the default path:

elebox-cli init

Edit Part category

List part categories:

elebox-cli category

Create a new part category named MCU:

elebox-cli category new MCU

Create new part category named ARM and RISC-V, and designate them as a subcategory of MCU:

elebox-cli category new ARM -p MCU
elebox-cli category new "RISC-V" -p MCU

Edit Part

List parts:

elebox-cli part

Create a new part named RP2040 with a part category of ARM, and a quantity of 25:

elebox-cli part new RP2040 25 ARM

Consume or restock 10 RP2040:

elebox-cli part use RP2040 10
elebox-cli part add RP2040 10

Rename RP2040 to rpi-RP2040:

elebox-cli part update RP2040 "rpi-RP2040"

License

Licensed under either of Apache-2.0 or MIT license at your option.

Icons from Material Design Icons