Skip to main content

Tool Guide 🔧

This technical reference sheet provides a detailed overview of the tools available at Toolworks.dev, along with a quick-start guide for essential developer tools like Python, Rust, npm, npx, Yarn, and Bun. Whether you're a beginner or an experienced developer, this guide will help you get started quickly.

Toolworks.dev Projects​

1. auto-md​

Convert files, folders, and GitHub repositories into AI/LLM-ready formats.

  • Use Cases:

    • Preparing datasets for machine learning.
    • Organizing and converting content for natural language processing (NLP) pipelines.

  • Key Features:

    • Batch processing for handling multiple files and directories.
    • Flexible configurations for custom Markdown output.
    • Lightweight, Python-based implementation optimized for speed.

2. trusty-notes​

A secure, cross-platform note-taking app with end-to-end encryption.

  • Use Cases:

    • Personal journaling with enhanced privacy.
    • Secure cloud-syncing for sensitive data like passwords or research notes.

  • Key Features:

    • End-to-end encryption to ensure data privacy.
    • Modern React-based user interface.
    • Offline-first design with seamless cloud sync.

3. image-tools​

A web app for resizing, compressing, and converting images between formats.

  • Use Cases:

    • Optimizing images for faster website loading times.
    • Bulk conversion and resizing for design workflows or content creation.

  • Key Features:

    • Drag-and-drop interface for ease of use.
    • Supports popular formats like PNG, JPEG, and WebP.
    • Fast and efficient batch processing.

Quick Start Guide for Developer Tools​

Python​

A versatile programming language used for scripting, automation, and building applications.

  • Install Python:
    Download the latest version from python.org.
    Verify installation:

    python --version
    pip --version

  • Basic Commands:

    • Install packages: 
      pip install <package-name>
    • Run a script: 
      python script.py
    • Virtual Environments: 
      python -m venv venv
      source venv/bin/activate  # macOS/Linux
      venv\Scripts\activate   # Windows

npm (Node Package Manager)​

The default package manager for Node.js, used to manage dependencies for JavaScript projects.

  • Install npm:
    npm is included with Node.js. Download from nodejs.org.
    Verify installation:

    npm --version

  • Basic Commands:

    • Initialize a project: 
      npm init -y
    • Install a package: 
      npm install <package-name>
    • Run a script: 
      npm run <script-name>

npx​

A package runner included with npm, useful for running Node.js packages without globally installing them.

  • Usage Examples:
    • Run a package directly: 
      npx create-react-app my-app
    • Execute a one-time script: 
      npx eslint . --fix

Yarn​

An alternative package manager to npm, focused on speed and reliability.

  • Install Yarn:
    Install globally using npm:

    npm install --global yarn

    Verify installation:

    yarn --version

  • Basic Commands:

    • Install dependencies: 
      yarn install
    • Add a package: 
      yarn add <package-name>
    • Run a script: 
      yarn <script-name>

Bun​

A modern JavaScript runtime and package manager known for its performance.

  • Install Bun:
    Install using the script from bun.sh:

    curl -fsSL https://bun.sh/install | bash

    Verify installation:

    bun --version

  • Basic Commands:

    • Initialize a project: 
      bun init
    • Install dependencies: 
      bun install
    • Run a script: 
      bun run <script-name>

Rust​

A systems programming language known for its performance and memory safety.

  • Install Rust:
    Use Rust’s official installer:

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

    Verify installation:

    rustc --version
    cargo --version

  • Basic Commands:

    • Create a new project: 
      cargo new my-project
      cd my-project
    • Build and run: 
      cargo build
      cargo run

Additional Resources​

Together, let’s simplify, enhance, and empower development workflows! 🚀