Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Command compatibility: New vibe-viewer and vibe-sketcher launchers require rename-aware builds. For current published archives or available public snapshots, use vibe-view and vibe-sketch; these deprecated commands remain supported with no removal date. vq is unchanged. Compatibility guide.
vibe-sketcher documentation
Light Logo Dark Logo
vibe-sketcher documentation

Getting started

  • Installation
  • Desktop app
  • Quickstart
  • Troubleshooting
  • Tutorials
    • Your first molecule
    • A reaction sketch
    • Draw a reaction, publish the figure and run it with vibe-qc
    • From sketch to a vibe-qc calculation input
    • Draw and publish a Diels–Alder reaction
    • Annotate mechanisms and connect reaction steps
    • Exchange structures and keep calculation results intact
    • Check stereochemistry, properties, names and spin
    • Clean the drawing and prepare 3D geometry
    • Generate every supported vibe-qc task
    • Portable geometry and optional ORCA inputs
    • Follow, cancel and reopen vibe-qc calculations
    • Reproduce a reaction with CLI, Python, REST and MCP
    • Open, edit and save in the desktop app
    • Use the keyboard and compact palette
    • Find a worked example for a feature
  • Runnable examples
  • Figures for papers
  • The browser app
  • Compound, fragment and named-reaction library
  • Drawing cleanup
  • Nanostructures
  • Surfaces, electrodes and nanoparticles
  • Electrode reactions
  • Redox and finite-cluster binding recipes
  • Tidy scheme
  • Results and reaction energies
  • Working with agents

Reference

  • The document format
  • File formats
  • Input writers
  • Calculation runs
  • Command line
  • REST API
  • Python API
    • vibesketch.document
      • vibesketch.document.abbreviations
      • vibesketch.document.apparatus
      • vibesketch.document.campaign
      • vibesketch.document.campaign_results
      • vibesketch.document.cdx
      • vibesketch.document.cdxml
      • vibesketch.document.clean
      • vibesketch.document.coordinates
      • vibesketch.document.derive
      • vibesketch.document.electrochem
      • vibesketch.document.electrochemical_recipes
      • vibesketch.document.embed
      • vibesketch.document.enumeration
      • vibesketch.document.external_results
      • vibesketch.document.formats
      • vibesketch.document.generics
      • vibesketch.document.geometry_return
      • vibesketch.document.highlights
      • vibesketch.document.io
      • vibesketch.document.ket
      • vibesketch.document.model
      • vibesketch.document.monomers
      • vibesketch.document.multiple_groups
      • vibesketch.document.nanostructures
      • vibesketch.document.nmr
      • vibesketch.document.orca
      • vibesketch.document.properties
      • vibesketch.document.qvf
      • vibesketch.document.reaction_library
      • vibesketch.document.recipe
      • vibesketch.document.relax
      • vibesketch.document.renders
      • vibesketch.document.results
      • vibesketch.document.review
      • vibesketch.document.rgfile
      • vibesketch.document.schema
      • vibesketch.document.scheme
      • vibesketch.document.sequences
      • vibesketch.document.solids
      • vibesketch.document.spectra
      • vibesketch.document.stereo
      • vibesketch.document.stoichiometry
      • vibesketch.document.surfaces
      • vibesketch.document.tables
      • vibesketch.document.template_library
      • vibesketch.document.tlc
    • vibesketch.chem
      • vibesketch.chem.analysis
      • vibesketch.chem.cip
      • vibesketch.chem.clean
      • vibesketch.chem.depiction
      • vibesketch.chem.embed
      • vibesketch.chem.endpoints
      • vibesketch.chem.fire
      • vibesketch.chem.formula
      • vibesketch.chem.layout
      • vibesketch.chem.mapping
      • vibesketch.chem.nanostructures
      • vibesketch.chem.perceive
      • vibesketch.chem.relax
      • vibesketch.chem.report
      • vibesketch.chem.species
    • vibesketch.naming
      • vibesketch.naming.opsin
    • vibesketch.render
      • vibesketch.render.chemfig
      • vibesketch.render.fonts
      • vibesketch.render.nanostructures
      • vibesketch.render.publication
      • vibesketch.render.scene
      • vibesketch.render.styles
      • vibesketch.render.surfaces
      • vibesketch.render.vector
    • vibesketch.inputs
      • vibesketch.inputs.base
      • vibesketch.inputs.neb
      • vibesketch.inputs.orca
      • vibesketch.inputs.orca_keywords
      • vibesketch.inputs.qcschema
      • vibesketch.inputs.recipe
      • vibesketch.inputs.registry
      • vibesketch.inputs.vibeqc
      • vibesketch.inputs.xyz
    • vibesketch.queue
    • vibesketch.viewer
    • vibesketch.server
      • vibesketch.server.documents
      • vibesketch.server.guard
      • vibesketch.server.store
    • vibesketch.agent
      • vibesketch.agent.client
      • vibesketch.agent.mcp
    • vibesketch.codenames
    • vibesketch.elements
    • vibesketch.units
  • Security and input bounds
  • Performance and accessibility checks
  • Release-paper evaluation protocol

The project

  • Roadmap
  • vibe-sketcher and vibe-viewer: responsibilities
  • Canvas spike: Ketcher behind the adapter
  • Release codenames
  • Licences
  • Release process
  • Changelog
Back to top
Copyright © 2026, Michael F. Peintinger
Made with Sphinx and @pradyunsg's Furo