New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details →
Socket
Book a DemoSign in
Socket

mujarrad-cli

Package Overview
Dependencies
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mujarrad-cli

⚠️ ALPHA: Obsidian Knowledge Graph Integration CLI - Sync your Obsidian vaults with Mujarrad workspaces

latest
Source
npmnpm
Version
1.2.0-alpha.2
Version published
Maintainers
1
Created
Source

MUJARRAD CLI

⚠️ ALPHA SOFTWARE - This CLI is currently in alpha development. Features may change without notice, and breaking changes may occur between versions. Use at your own risk. See Version Status for details.

╔═══╗
          ║▓▓▓║     ╔═══╗
          ║▓▓▓║═════╣▓▓▓║
              ╚═══╝     ║▓▓▓║═══╗
                        ╚═══╝   ║
                                ║
                                    ╚═══╝

   ███╗   ███╗██╗   ██╗     ██╗ █████╗ ██████╗ ██████╗  █████╗ ██████╗
    ████╗ ████║██║   ██║     ██║██╔══██╗██╔══██╗██╔══██╗██╔══██╗██╔══██╗
    ██╔████╔██║██║   ██║     ██║███████║██████╔╝██████╔╝███████║██║  ██║
    ██║╚██╔╝██║██║   ██║██   ██║██╔══██║██╔══██╗██╔══██╗██╔══██║██║  ██║
    ██║ ╚═╝ ██║╚██████╔╝╚█████╔╝██║  ██║██║  ██║██║  ██║██║  ██║██████╔╝
    ╚═╝     ╚═╝ ╚═════╝  ╚════╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝╚═════╝

   ╔═══════════════════════════════════════════════════════════════════╗
   ║                          DATA UNLOCKD                             ║
   ╚═══════════════════════════════════════════════════════════════════╝

The Ultimate Abstraction Application

Unlock, Distill, and Amplify Your Data

npm version License: Apache 2.0 Node.js Version

Version Status

Current Version: 1.2.0-alpha.2 (Alpha)

This CLI is in active alpha development. While core functionality is stable and tested, you should expect:

  • Feature Changes: New features may be added, modified, or removed based on feedback
  • Breaking Changes: Commands, options, and configurations may change between minor versions
  • API Evolution: The underlying API and data structures are being refined
  • Beta Timeline: We expect to reach beta status after completing comprehensive user testing

What's Stable:

  • ✅ Authentication (login, logout, registration)
  • ✅ Upload workflow (vault to workspace)
  • ✅ Clone workflow (workspace to vault)
  • ✅ Sync workflow (bidirectional synchronization)
  • ✅ Template system (list and clone)
  • ✅ Canvas support (visual preservation)
  • ⚠️ Developer SDK (@mujarrad/sdk) — alpha

What's Being Refined:

  • ⚠️ Error messages and user feedback
  • ⚠️ Performance optimization
  • ⚠️ Edge case handling
  • ⚠️ Advanced conflict resolution

Reporting Issues: Please report bugs and feedback at GitHub Issues. Your feedback helps us improve!

What is Mujarrad?

Mujarrad is the data superpower that transforms complexity into clarity. We don't just manage data—we unlock its potential, distill its essence, and amplify its impact.

The Mujarrad Philosophy

In a world drowning in noise, chaos, and complexity, Mujarrad reveals the signal. We architect intelligent abstractions that transform overwhelming data landscapes into elegant, composable building blocks.

We harness complexity. We deliver simplicity.

What We Do to Data

🔓 UNLOCK

  • Reveal hidden patterns
  • Demystify complex structures
  • Unleash trapped potential
  • Activate dormant insights
  • Empower decision-making

🎯 DISTILL

  • Refine noise into signal
  • Sculpt chaos into order
  • Translate complexity to clarity
  • Distill essence from bulk
  • Extract core meaning

AMPLIFY

  • Accelerate workflows
  • Scale operations effortlessly
  • Automate repetitive tasks
  • Innovate with freed resources
  • Evolve continuously

Core Principles

🧩 Abstraction as Power We compose data into polymorphic, flexible blocks—adaptive components that evolve with your needs.

🏗️ Architecture as Art Every layer is engineered with elegance. Our framework provides the foundation for scalable, intelligent systems.

⚙️ Intelligence in Action Data-driven, smart, sophisticated operations that master complexity and deliver results.

🌊 Fluid by Design Dynamic, elastic, agile structures that embrace change and flow with your requirements.

Features

🚀 Obsidian Vault Integration

Transform your Obsidian knowledge base into a powerful, structured graph. Upload notes, folders, and canvases while preserving every visual detail and connection.

🔄 Bidirectional Sync

Real-time synchronization keeps your data flowing seamlessly. Work offline or online—Mujarrad adapts to your workflow.

🎨 Canvas Visual Preservation

Pixel-perfect accuracy maintains your creative layouts. Every position, color, and connection is preserved with precision.

📚 Template System

Accelerate project creation with pre-built frameworks. Business Model Canvas, SWOT Analysis, and more—all ready to activate.

🔐 Smart Security

Encrypted credentials, intelligent access control, secure by design. Your data's foundation is solid.

📊 Version Control

Track every change, master your history. Git integration provides complete insight into your data's evolution.

Performance Engineered

Batch processing, efficient algorithms, optimized operations. Speed meets sophistication.

Installation

npm install -g mujarrad-cli

NPX (No Installation Required)

npx mujarrad-cli [command]

Prerequisites

  • Node.js: >= 18.0.0
  • Git: >= 2.20 (for version control features)
  • Obsidian: Compatible with all vault formats

Quick Start

1. Authenticate & Activate

mujarrad auth login

Unlock your workspace with secure credentials.

2. Upload & Transform

mujarrad upload ./my-vault --workspace my-workspace

Distill your Obsidian vault into structured, intelligent data.

3. Clone & Recreate

mujarrad clone ./new-vault --workspace my-workspace

Realize your knowledge graph anywhere, anytime.

4. Sync & Flow

mujarrad sync ./my-vault --watch

Embrace continuous synchronization—data that adapts and evolves.

SDK Quick Start (For Developers)

Use Mujarrad as a graph-based backend for your apps — like Firebase/Supabase, but graph-native.

1. Install the CLI and log in

npm install -g mujarrad-cli
mujarrad auth login

2. Scaffold a project

mujarrad sdk init my-app
cd my-app && npm install

3. Define your schema

// src/schema.ts
import { defineSchema } from '@mujarrad/sdk';

export const schema = defineSchema()
  .entity('Task').string('title', { required: true }).enum('status', ['todo', 'done']).done()
  .build();

4. Use the SDK

// src/index.ts
import { Mujarrad } from '@mujarrad/sdk';
import { schema } from './schema.js';

const client = new Mujarrad({
  apiKey: process.env.MUJARRAD_PUBLIC_KEY!,
  secretKey: process.env.MUJARRAD_SECRET_KEY!,
  space: process.env.MUJARRAD_SPACE!,
}).withSchema(schema);

const task = await client.createEntity('Task', { title: 'Ship it', status: 'todo' });

5. Run

npm start

See packages/sdk/README.md for full API reference, or browse the Developer Documentation:

Architecture

Mujarrad CLI is engineered with a 5-layer abstraction—each layer refined, composable, and intelligent:

┌─────────────────────────────────────┐
│   Commands Layer                    │  ← CLI Interface
│   (User Interaction)                │
└────────────┬────────────────────────┘
             ↓
┌─────────────────────────────────────┐
│   Services Layer                    │  ← Business Logic
│   (Core Intelligence)               │
└────────────┬────────────────────────┘
             ↓
┌─────────────────────────────────────┐
│   Workflows Layer                   │  ← Orchestration
│   (Multi-Step Automation)           │
└────────────┬────────────────────────┘
             ↓
┌─────────────────────────────────────┐
│   API Client Layer                  │  ← Communication
│   (Auto-Generated from OpenAPI)     │
└────────────┬────────────────────────┘
             ↓
┌─────────────────────────────────────┐
│   File System Layer                 │  ← Data Source
│   (Vault Scanning & Parsing)        │
└─────────────────────────────────────┘

Layered, scalable, elegant—architecture as art.

Commands

Authentication

mujarrad auth login          # Unlock your workspace
mujarrad auth logout         # Secure logout
mujarrad auth status         # Check authentication state

Workspace Management

mujarrad workspace create    # Build new workspace
mujarrad workspace list      # View all workspaces
mujarrad workspace delete    # Remove workspace

Data Operations

# Upload: Transform local vaults into structured workspaces
mujarrad upload <vault-path> --workspace <slug>

# Clone: Recreate workspaces as local vaults
mujarrad clone <target-path> --workspace <slug>

# Sync: Flow data bidirectionally
mujarrad sync <vault-path> [--watch]

Template System

mujarrad template list                    # Discover frameworks
mujarrad template clone <target-path>     # Activate template
  --template <id>                         # Framework identifier
  --name <workspace-name>                 # Your workspace name

SDK (Developer Tools)

mujarrad sdk init <project-name>         # Scaffold a new SDK project
mujarrad sdk keygen                      # Generate a new API key pair
mujarrad sdk keygen --name "production"  # Generate a named key pair

Version History

mujarrad history <node-id>                # View evolution
mujarrad history diff <node-id> <v1> <v2> # Compare versions

Help & Documentation

mujarrad --help              # Master all commands
mujarrad <command> --help    # Command-specific guidance

Configuration

Mujarrad adapts to your environment. Configuration stored in ~/.mujarrad/config.json:

{
  "apiBaseUrl": "https://mujarrad.onrender.com",
  "defaultWorkspace": "my-workspace",
  "autoSync": false,
  "logLevel": "info"
}

Note: v1.1.0+ automatically migrates old config files with incorrect API URLs.

Credential Storage

Secure by design, intelligent by default:

  • macOS: Keychain Access
  • Windows: Credential Manager
  • Linux: libsecret
  • Fallback: AES-256 encrypted ~/.mujarrad/credentials.json (permissions: 600)

Use Cases

📊 Business Strategy

Accelerate planning with Business Model Canvas templates. Distill complex strategies into visual, actionable frameworks.

🎓 Research & Knowledge Management

Unlock research potential with interconnected notes. Compose ideas into fluid, evolving knowledge graphs.

💼 Project Management

Master project complexity with structured templates. Track versions, synchronize teams, deliver results.

🚀 Product Development

Engineer product roadmaps with canvas visualizations. Refine requirements, translate vision to reality.

Examples

Example 1: Business Model Canvas

# Upload complete business model vault
mujarrad upload ./business-models --workspace startup-canvas

# Visual properties preserved:
# • Node positions, sizes, colors
# • Edge connections and styles
# • Canvas-wide zoom and viewport settings
# • Wikilink relationships

Example 2: Template-Based Workflow

# Discover available frameworks
mujarrad template list

# Activate Business Model Canvas template
mujarrad template clone ./my-startup \
  --template business-model-canvas \
  --name "My Startup"

# Template includes:
# • Pre-structured canvas layouts
# • Placeholder nodes with guidance
# • Template configuration file
# • Framework-specific structure

Example 3: Continuous Synchronization

# Enable real-time sync with watch mode
mujarrad sync ./my-vault --watch

# Mujarrad monitors and responds:
# ✓ Detects: new files, updates, deletions
# ✓ Handles: conflict resolution, version tracking
# ✓ Flows: bidirectional synchronization

Philosophy in Action

The Mujarrad Advantage

Traditional data tools complicate. They add layers of noise, require complex setup, and constrain flexibility.

Mujarrad simplifies. We:

  • Unlock data from rigid structures
  • Distill complexity into elegant abstractions
  • Amplify your productivity with intelligent automation
  • Compose flexible, adaptive systems
  • Deliver clarity from chaos

What Makes Us Different

ConceptTraditional ApproachMujarrad Approach
AbstractionHidden complexity, rigid structuresComposable blocks, polymorphic design
Data FlowManual, error-prone transfersAutomated, intelligent sync
Visual DesignLost in translationPixel-perfect preservation
ScalabilityPerformance degradationEngineered for scale
FlexibilityLocked into workflowsAdaptive, fluid by design

Troubleshooting

Authentication Issues

# Diagnose authentication state
mujarrad auth status

# Reset and re-authenticate
mujarrad auth logout
mujarrad auth login

Note: If you installed v1.0.0-1.1.0-alpha.3 and experience 403 errors, simply upgrade to v1.1.0-alpha.4:

npm install -g mujarrad-cli@latest

The CLI will automatically fix your config file on next run.

Sync Conflicts

Mujarrad uses intelligent conflict resolution:

  • Last-write-wins for concurrent edits (timestamp-based)
  • UUID suffix for name conflicts (Note-a1b2c3d4.md)
  • Interactive prompts for complex scenarios

Performance Optimization

# View detailed logs
tail -f ~/.mujarrad/logs/mujarrad.log

# Adjust log level in config
{
  "logLevel": "debug"  // Options: error, warn, info, debug
}

Git Integration

# Verify Git installation
git --version

# Configure Git identity
git config --global user.name "Your Name"
git config --global user.email "you@example.com"

Development

Setup

git clone https://github.com/mujarrad/mujarrad-cli.git
cd mujarrad-cli
npm install

Build & Run

npm run build        # Compile TypeScript
npm run dev          # Development mode
npm start            # Production mode

Testing

npm test                  # Run all tests
npm run test:watch        # Watch mode
npm run test:coverage     # Generate coverage report

Test-Driven Development: We engineer quality through comprehensive test coverage.

Code Quality

npm run lint              # Check for errors
npm run lint:fix          # Auto-fix issues
npm run format            # Format code (Prettier)

Roadmap

Phase 0: Project Setup ✅

  • TypeScript 5.3 with ES modules
  • Jest testing framework
  • Project directory structure
  • Brand identity

Phase 1: Foundational Components ✅

  • API client generation (OpenAPI → TypeScript)
  • Configuration management (cosmiconfig)
  • Credential security (OS keychain + AES-256)
  • Logging infrastructure (winston)
  • Progress UI (ora + cli-progress)
  • Frontmatter parsing

Phase 2: Authentication & API Integration ✅

  • AuthService (JWT with refresh)
  • RetryHandler (exponential backoff)
  • ErrorHandler (user-friendly messages)
  • ResponseValidator (type-safe validation)
  • auth CLI commands

Phase 3: File Scanning & Parsing ✅

  • Vault scanning (recursive .md/.canvas)
  • Markdown parsing (wikilinks, frontmatter)
  • Canvas processing (JSON Canvas spec)
  • Metadata management (UUID embedding)
  • Local caching (workspace structure)

Phase 4: Upload Workflow ✅

  • UploadService (batch upload)
  • upload CLI command
  • Session management
  • Progress tracking

Phase 5: Clone Workflow ✅

  • CloneService (workspace export)
  • clone CLI command
  • Git initialization (simple-git)
  • ZIP extraction (unzipper)
  • Vault recreation

Phase 6: Sync Workflow ✅

  • SyncService (bidirectional sync)
  • ConflictResolver (merge strategies)
  • sync CLI command
  • Watch mode for continuous sync

Phase 7: Canvas Support ✅

  • CanvasUploadService (visual property extraction)
  • CanvasCloneService (canvas reconstruction)
  • NFR-031: Visual accuracy within ±1 pixel

Phase 8: Template System ✅

  • TemplateService (list, get, search, popular)
  • TemplateCloneWorkflow (instantiate and clone)
  • template CLI commands (list, clone)
  • Template configuration management

Phase 9: Developer SDK ✅

  • @mujarrad/sdk npm package (nodes, attributes, spaces, batch)
  • Schema builder with fluent API
  • Schema validation
  • HTTP client with retry + error mapping
  • mujarrad sdk init project scaffolding
  • mujarrad sdk keygen API key generation

Phase 10: Additional Features 📋

  • Workspace management commands
  • Version history commands
  • Sharing commands
  • Status command

Phase 11: Distribution ✅

  • NPM package (v1.2.0-alpha.2 published)
  • User documentation (README.md)
  • Developer documentation (inline comments + specs)

Current Version: 1.2.0-alpha.2 - Published on npm

See tasks.md for detailed implementation plan.

Contributing

Contributions empower the Mujarrad ecosystem. We welcome your innovations.

Development Workflow

  • Fork the repository
  • Create feature branch (git checkout -b feature/amazing-feature)
  • Write tests first (TDD approach)
  • Implement your feature
  • Ensure tests pass (npm test)
  • Commit your changes (git commit -m 'Add amazing feature')
  • Push to branch (git push origin feature/amazing-feature)
  • Open Pull Request

Code Standards

  • Test-Driven Development (TDD) is non-negotiable
  • TypeScript strict mode enforced
  • ESLint and Prettier for code quality
  • Comprehensive documentation required

The Mujarrad Lexicon

Core Concepts

AbstractAbstractionAdaptiveAgileBlockComposableComplexDataData-DrivenDirectDistilledDynamicElasticElegantEssentialFlexibleFluidIntelligentPolymorphicPowerfulRefinedSimpleSimplicitySmartSophisticatedUniversal

Actions

AccelerateActivateAdaptAmplifyAutomateBuildCommandComposeCreateDeliverDemystifyDistillEmbraceEmpowerEngineerEvolveHarnessInnovateMasterRealizeRefineRevealScaleSculptSolveTranslateUnlockUnleash

Outcomes

AdvantageAgilityArtClarityEdgeEfficiencyFlowFocusFoundationFreedomInsightLogicOrderPowerPotentialScaleSignalSolutionSpeedStructureSuperpower

Metaphors

ArchitectureBlueprintBlocksChaosCodeComponentsCoreEngineFrameworkLayerMapMazeNoisePlatformSourceSystem

License

Apache License 2.0 - see LICENSE file for details.

Freedom to build, adapt, and innovate.

Support

Built with Intelligence. Designed for Power. Engineered for You.

Mujarrad: Where Data Complexity Becomes Elegant Simplicity

WebsiteDocumentationCommunity

DATA UNLOCKD

Keywords

obsidian

FAQs

Package last updated on 12 Feb 2026

Did you know?

Socket

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.

Install

Related posts