Production-ready GitHub-backed NoSQL Database with CLI, Shell, and REST API
A production-ready CLI tool and API server for managing a NoSQL database using GitHub repositories as storage. Features both command-line interface and REST API with interactive shell.
npm run build:prod
npm run build:installers
# Professional MSI Installer (Recommended)
GitDB-2.0.0-x64.msi # 64-bit Windows
GitDB-2.0.0-x86.msi # 32-bit Windows
# Or use NSIS installer
GitDB-Setup-v2.0.0.exe
# Or use batch installer
install-gitdb-windows.bat
# Make executable and run
chmod +x install-gitdb-macos.sh
./install-gitdb-macos.sh
# Make executable and run
chmod +x install-gitdb-linux.sh
./install-gitdb-linux.sh
# Windows
gitdb-server.exe
# Linux/macOS
gitdb-server
# Windows
gitdb-shell.exe
# Linux/macOS
gitdb-shell
# Windows
gitdb-cli.exe --help
# Linux/macOS
gitdb-cli --help
Start the interactive shell for database operations:
gitdb-shell
🔗 Connection:
connect <token> <owner> <repo> Connect to database
disconnect Disconnect from database
status Show connection status
📁 Collections:
collections List all collections
create-collection <name> Create a new collection
delete-collection <name> Delete a collection
use <collection> Set current collection
📄 Documents:
docs List documents in current collection
insert <json> Insert a new document
find <id> Find document by ID
update <id> <json> Update document by ID
delete <id> Delete document by ID
🛠️ Utility:
clear Clear screen
help Show this help
exit, quit Exit shell
🚀 GitDB Shell - GitHub-backed NoSQL Database
gitdb> connect your_token your_username your_repo
✅ Connected to database: your_username/your_repo
gitdb> create-collection users
✅ Collection 'users' created successfully
gitdb> use users
📁 Using collection: users
gitdb> insert {"name":"Alice","email":"alice@example.com"}
✅ Document created with ID: abc123def456
gitdb> find abc123def456
{
"_id": "abc123def456",
"name": "Alice",
"email": "alice@example.com",
"createdAt": "2024-01-01T12:00:00.000Z"
}
gitdb> update abc123def456 {"email":"alice@new.com"}
✅ Document updated successfully
gitdb> docs
📄 Documents in 'users':
- abc123def456
gitdb> exit
👋 Goodbye!
Use the CLI for scripting and automation:
gitdb-cli --help
# Connect to database
gitdb-cli connect -t <token> -o <owner> -r <repo>
# List collections
gitdb-cli collections
# Create collection
gitdb-cli create-collection <name>
# Delete collection
gitdb-cli delete-collection <name>
# List documents in collection
gitdb-cli documents <collection>
# Create document
gitdb-cli create-doc <collection> '{"name":"John","email":"john@example.com"}'
# Read document
gitdb-cli read-doc <collection> <id>
# Update document
gitdb-cli update-doc <collection> <id> '{"email":"john@new.com"}'
# Delete document
gitdb-cli delete-doc <collection> <id>
# Find documents by query
gitdb-cli find <collection> '{"name":"John"}'
# Show status
gitdb-cli status
The API server provides RESTful endpoints for database operations.
gitdb-server
The server will start on port 7896 by default.
http://localhost:7896/api/v1
First, connect to a database:
POST /api/v1/collections/connect
Content-Type: application/json
{
"token": "your_github_token",
"owner": "your_username",
"repo": "your_repo"
}
GET /api/v1/collections
POST /api/v1/collections
Content-Type: application/json
{
"name": "users"
}
DELETE /api/v1/collections/users
GET /api/v1/collections/users
GET /api/v1/collections/users/documents
POST /api/v1/collections/users/documents
Content-Type: application/json
{
"name": "Alice",
"email": "alice@example.com"
}
GET /api/v1/collections/users/documents/abc123def456
PUT /api/v1/collections/users/documents/abc123def456
Content-Type: application/json
{
"email": "alice@new.com"
}
DELETE /api/v1/collections/users/documents/abc123def456
POST /api/v1/collections/users/documents/find
Content-Type: application/json
{
"name": "Alice"
}
const axios = require('axios');
class GitDBClient {
constructor(baseURL = 'http://localhost:7896/api/v1') {
this.baseURL = baseURL;
}
async connect(token, owner, repo) {
const response = await axios.post(`${this.baseURL}/collections/connect`, {
token, owner, repo
});
return response.data;
}
async createCollection(name) {
const response = await axios.post(`${this.baseURL}/collections`, { name });
return response.data;
}
async insertDocument(collection, data) {
const response = await axios.post(`${this.baseURL}/collections/${collection}/documents`, data);
return response.data;
}
async getDocument(collection, id) {
const response = await axios.get(`${this.baseURL}/collections/${collection}/documents/${id}`);
return response.data;
}
async updateDocument(collection, id, data) {
const response = await axios.put(`${this.baseURL}/collections/${collection}/documents/${id}`, data);
return response.data;
}
async deleteDocument(collection, id) {
const response = await axios.delete(`${this.baseURL}/collections/${collection}/documents/${id}`);
return response.data;
}
}
// Usage
const gitdb = new GitDBClient();
await gitdb.connect('your_token', 'your_username', 'your_repo');
await gitdb.createCollection('users');
await gitdb.insertDocument('users', { name: 'Alice', email: 'alice@example.com' });
import requests
import json
class GitDBClient:
def __init__(self, base_url="http://localhost:7896/api/v1"):
self.base_url = base_url
self.session = requests.Session()
self.session.headers.update({'Content-Type': 'application/json'})
def connect(self, token, owner, repo):
response = self.session.post(f"{self.base_url}/collections/connect",
json={'token': token, 'owner': owner, 'repo': repo})
return response.json()
def create_collection(self, name):
response = self.session.post(f"{self.base_url}/collections", json={'name': name})
return response.json()
def insert_document(self, collection, data):
response = self.session.post(f"{self.base_url}/collections/{collection}/documents",
json=data)
return response.json()
def get_document(self, collection, doc_id):
response = self.session.get(f"{self.base_url}/collections/{collection}/documents/{doc_id}")
return response.json()
def update_document(self, collection, doc_id, data):
response = self.session.put(f"{self.base_url}/collections/{collection}/documents/{doc_id}",
json=data)
return response.json()
def delete_document(self, collection, doc_id):
response = self.session.delete(f"{self.base_url}/collections/{collection}/documents/{doc_id}")
return response.json()
# Usage
gitdb = GitDBClient()
gitdb.connect('your_token', 'your_username', 'your_repo')
gitdb.create_collection('users')
gitdb.insert_document('users', {'name': 'Alice', 'email': 'alice@example.com'})
src/
├── api/ # REST API routes
├── core/ # Database manager and CRUD operations
├── github/ # GitHub API integration
├── models/ # Data models
├── utils/ # Utility functions
├── config/ # Configuration files
├── cli.ts # Command-line interface
├── shell.ts # Interactive shell
└── server.ts # API server
npm run build - Build TypeScript to JavaScriptnpm run build:prod - Complete production buildnpm run build:installers - Build all installersnpm run dev - Start development server with hot reloadnpm run start - Start production servernpm run shell - Start interactive shellnpm run cli - Run CLI commandsnpm run clean - Clean build directoryMIT
FAQs
Production-ready GitHub-backed NoSQL Database with CLI, Shell, and REST API
The npm package gitdb-cli receives a total of 0 weekly downloads. As such, gitdb-cli popularity was classified as not popular.
We found that gitdb-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Application Security
/Security News
Socket CEO Feross Aboukhadijeh and a16z partner Joel de la Garza discuss vibe coding, AI-driven software development, and how the rise of LLMs, despite their risks, still points toward a more secure and innovative future.
Research
/Security News
Threat actors hijacked Toptal’s GitHub org, publishing npm packages with malicious payloads that steal tokens and attempt to wipe victim systems.
Research
/Security News
Socket researchers investigate 4 malicious npm and PyPI packages with 56,000+ downloads that install surveillance malware.