Skip to content

VibTools Product Catalog Manifest Specification

Official schema for vibtools.json manifests to automate project imports, catalogs, social OG preview cards, and non-technical user documentation.

stable

Overview

Schema
VibTools
Version
v1.0.0
Draft
2020-12
License
MIT
Compatibility
VibTools v1

Properties

NameTypeRequiredDescription
$schemastring (URI)YesCanonical VibTools Version 1 schema URL.
namestringYesProduct display name.
slugstringYesUnique URL slug identifier.
categorystringNoProduct catalog category.
statusstringNoRelease or availability status.
versionstringNoCurrent release version.
subtitlestringNoPrimary tag or subtitle summary.
repositorystringNoGitHub repository path or URL.
descriptionstringNoComprehensive product description.
assetsobjectNoLogos, social OG image cards (1200x630), banners, and screenshots.
documentsobjectNoPaths to non-technical user guides: quick-start, features, FAQ, and what's new.
linksobjectNoDownload link, live demo, docs, and repo links.
tagsarrayNoKeywords and filter tags array.
flagsobjectNoActive, open-source, and featured highlight flags.
customobjectNoCustom vendor-specific extensions.

Social OG Previews (1200x630)

New Feature

VibTools manifests now support automated OpenGraph preview cards via assets.ogImageUrl (or assets.ogImage). When sharing tool links on Twitter/X, Discord, LinkedIn, or Slack, social platforms automatically display a high-definition 1200×630 branded card.

Social Share Card Preview (1200×630)ogImageUrl: /vibtools/assets/og-image.png
VibTools OpenGraph Social Preview Card
Specifications:1200×630 Resolution16:9 / 1.91:1 Aspect RatioLocal Relative Paths & Remote URLs

Non-Technical User Guides

documents

For everyday users, creators, and non-developers, the manifest provides a dedicated documents mapping with plain-language Markdown guides requiring zero terminal commands:

⚡

Quick Start

Zero-code onboarding for everyday users. Get running in 3 simple steps without touching a terminal.

documents.quickStartView Guide →
📋

Features

Non-technical overview of visual workspace presets, automatic window saving, and local-first privacy.

documents.featuresView Guide →
❓

FAQ

Plain-English answers to questions regarding free usage, local storage, security, and update channels.

documents.faqView Guide →
✨

What's New

Release highlights, new visual capabilities, OpenGraph social cards, and future roadmap sneak peeks.

documents.whatsNewView Guide →

VibTools Workspace Hub (/vibtools/)

Folder Structure

A dedicated /vibtools/ workspace folder is maintained in the project repository containing all specification assets, manifests, and non-technical documentation:

vibtools/
├── README.md          # Overview and navigation
├── vibtools.json       # Canonical reference manifest
├── quick-start.md      # 3-step beginner guide
├── features.md         # Plain-language features
├── faq.md              # Frequently asked questions
├── whats-new.md        # Release highlights
└── assets/
├── og-image.png    # 1200x630 social card
├── logo.png        # 512x512 square logo
├── thumbnail.png   # 800x450 banner
└── screenshot.png  # 1200x675 UI preview

Example

vibtools.json
{
  "$schema": "https://schema.ygit.dev/vibtools/v1/vibtools.schema.json",
  "schemaVersion": 1,
  "name": "Session Manager Pro",
  "slug": "session-manager-pro",
  "category": "Desktop Apps",
  "status": "Available",
  "version": "1.0.0",
  "subtitle": "Windows, Automation, Utility",
  "repository": "vibtools/session-manager-pro",
  "description": "A powerful session and workspace management utility for Windows power users. Automates window positioning, workspace state saving, and instant multi-monitor workspace restoration.",
  "assets": {
    "logoUrl": "vibtools/assets/logo.png",
    "thumbnailUrl": "vibtools/assets/thumbnail.png",
    "ogImageUrl": "vibtools/assets/og-image.png",
    "screenshots": [
      "vibtools/assets/screenshot.png"
    ]
  },
  "documents": {
    "quickStart": "vibtools/quick-start.md",
    "features": "vibtools/features.md",
    "faq": "vibtools/faq.md",
    "whatsNew": "vibtools/whats-new.md"
  },
  "links": {
    "liveDemo": "https://demo.vib.tools",
    "download": "https://vib.tools/downloads/v1.0.0.exe",
    "docs": "https://docs.vib.tools/session-manager-pro",
    "github": "https://github.com/vibtools/session-manager-pro"
  },
  "tags": [
    "Desktop",
    "Automation",
    "Free",
    "Open Source"
  ],
  "flags": {
    "isActive": true,
    "isOpenSource": true,
    "isFeatured": false
  }
}

Downloads

Use the immutable VibTools Version 1 URL in manifests and automation.