Installation
Install Toolless and set up your first database
Package Installation
Install Toolless using your preferred package manager:
npm install toollessdbpnpm add toollessdbyarn add toollessdbTypeScript Support
Toolless includes TypeScript definitions out of the box. No additional @types packages required.
Global CLI Installation
For command-line access from anywhere:
npm install -g toollessdbVerify the installation:
toollessdb --versionQuick Verification
Create a simple test to verify everything works:
import { createClient } from "toollessdb";
const client = createClient({ path: "./test-data" });
const db = client.db("test");
const items = db.collection("items");
await items.insertOne({ name: "Test Item", created: new Date().toISOString() });
const result = await items.findOne({ name: "Test Item" });
console.log(result);Run with:
npx tsx test.tsProject Setup
For a new project:
mkdir my-project && cd my-project
npm init -y
npm install toollessdb typescript tsx
mkdir dataCreate your database module:
import { createClient } from "toollessdb";
const client = createClient({ path: "./data" });
const db = client.db("myapp");
export { client, db };Data Directory
Make sure the data directory exists and has write permissions. Toolless will create database folders inside this directory.
From Source
Clone and build from source:
git clone https://github.com/habibthadev/toolless.git
cd toolless
pnpm install
pnpm buildRequirements
- Node.js 18 or later
- File system with read/write access
- No external database servers required