Atomic Chat Documentation

repository·main·Indexed 22 days ago

https://github.com/atomicbot-ai/atomic-chat

An OpenAI API-compatible local LLM interface and server that supports inference engines like llama.cpp and MLX. Documentation includes guides for the AutoQA E2E test runner, ReportPortal integration, and developer instructions for building extensions using the @janhq/core package.

Tokens
223.8K
Snippets
578
Records
1.1K
Agent score
78%

What's inside Atomic Chat

  1. Overview of Jan-v2-VL

    main
    Jan-v2-VL is an 8B vision-language model (VLM) built on Qwen3-VL-8B-Thinking. It is specifically designed for long-horizon, multi-step agentic automation tasks in software environments like web browsers and desktop applications. It combines language reasoning with visual perception to perform screenshot grounding, tool calling (e.g., BrowserMCP), and error recovery during complex automation chains.
  2. Overview of AutoQA Scripts

    main
    The autoqa/scripts/ directory contains platform-specific scripts used by the AutoQA GitHub Actions workflow. These scripts are designed to handle the lifecycle of Atomic Chat during automated testing, including downloading, installing, running tests, and cleaning up installations across Windows, Ubuntu, and macOS. Using these scripts improves workflow maintainability by moving complex logic out of YAML files and into dedicated, testable files.
  3. Manage Apple Notes via the `memo` CLI

    main

    The apple-notes skill allows you to manage Apple Notes on macOS using the memo command-line utility. This enables creating, viewing, searching, editing, and exporting notes that sync across Apple devices via iCloud.

    Requirements:

    • Platform: macOS (darwin) only.
    • Tool: Requires the memo CLI installed via Homebrew.
    • Permissions: Requires macOS Automation permissions for Notes.app.

    When to use:

    • When the user wants notes that sync to iPhone/iPad/Mac via iCloud.

    When NOT to use:

    • For Markdown-native vault management (use obsidian instead).
    • For agent-internal scratch notes (use memory.notes.store instead).
    • For other note apps like Bear (this skill only supports Apple Notes).
  4. Explore the Jan Ecosystem

    main

    Jan provides several ways to interact with local AI, depending on your needs:

    • Jan Desktop: Full macOS, Windows, and Linux applications with offline support.
    • Jan Web: A browser-based interface available at https://chat.jan.ai.
    • Jan Server: A local, OpenAI-compatible API server for programmatic access.
    • Jan CLI: A terminal interface to serve local models and launch autonomous agents.
    • Jan Models: Optimized foundation models designed for reasoning, agents, and deep research that run on personal hardware.
    • Jan Platform: Infrastructure for building AI products (Coming Soon).
  5. Use the gog-workspace skill for Google Workspace tasks

    main

    The gog-workspace skill allows an agent to interact with Google Workspace services (Gmail, Calendar, Drive, Docs, Sheets, Contacts) using the gog CLI.

    Key Requirements:

    • Tools: Requires os.shell.run and skill.run_script.
    • Scripts: Uses check-gog.sh via skill.run_script for diagnostics.
    • Execution Pattern: Every gog operation must be an external CLI invocation using os.shell.run with cmd: "gog" and a separate args array. Do not use skill.run_script for general gog commands.
    • Platforms: Supported on darwin and linux.
  6. Navigate the Atomic Chat documentation structure

    main

    The documentation is organized into specific routes to help different types of users find information:

    • /guides/: Instructions for end users on how to use the Atomic Chat application.
    • /developer/: Documentation for developers looking to extend the software.
    • /api-reference/: Swagger/OpenAPI reference for the Jan API server.
    • /changelog/: Release history and changes.
    • /blog/: Project blog posts.
  7. Explore Jan app features

    main

    Jan provides several advanced features beyond basic chat to help organize and extend your AI workflows:

    • Projects: Organize conversations using shared instructions and files.
    • Assistants: Set up personal AI assistants tailored to specific workflows.
    • Agents: Use autonomous AI that can read files, manage calendars, and take actions.
    • Connectors (MCP): Extend your AI capabilities using the Model Context Protocol (MCP) to connect to web search, code execution, databases, and more.
  8. Available Jan applications and platforms

    main

    Jan is available across multiple platforms to suit different workflows:

    • Desktop: A standalone application for local use.
    • Browser: A web-based interface accessible via chat.jan.ai.
    • Browser Extension: (Coming soon).
    • Jan Server: For programmatic or server-side integration.

    While desktop and server options are available, the project is prioritizing the web experience for browser-based usage.

  9. Use the apple-calendar skill on macOS

    main

    The apple-calendar skill allows an agent to read Apple Calendar events using the icalBuddy CLI and create new events using AppleScript (osascript).

    Requirements:

    • Platform: macOS only (darwin).
    • Tools: Requires os.shell.run capability.
    • Dependencies: icalBuddy must be installed via Homebrew, and the terminal/agent must have Calendar permissions in macOS Privacy & Security settings.

    Capabilities:

    • Read: Check today's agenda, upcoming events, or specific calendar details.
    • Write: Add new events to a specific calendar (e.g., "Home").

    Limitations:

    • It is read-only for icalBuddy commands; all writes must use osascript.
    • It does not support Google Calendar (use gog-workspace) or non-time-based tasks (use apple-reminders).
  10. What is Deep Research and how does it work?

    main

    Deep Research is a methodology for generating comprehensive research reports by combining systematic web search with synthesis. It typically operates as a structured pipeline with distinct phases:

    1. Planning: Breaking down the user query into research goals.
    2. Searching: Executing exhaustive searches (both breadth-first for wide coverage and depth-first for specific details).
    3. Analysis: Processing the collected raw sources or summaries.
    4. Synthesis: Creating a final comprehensive report.

    Key components include the use of 'thinking' models and the ability to use tools (like search engines and scrapers) to interact with the web.

  11. Introduction to GPU kernels and benchmarking

    main

    In GPU programming, a kernel is a piece of CUDA code designed to execute a specific sequence of operations on the GPU. Kernels are launched within a thread block grid, which executes the kernel across multiple Streaming Multiprocessors (SMs) across the entire GPU.

    Benchmarking is used to quantitatively compare kernel performance across different problem sizes and to understand how hyperparameters impact execution speed. This is critical for iteratively optimizing kernels to maximize GPU utilization.

    Benchmarking Approaches

    • Python-based Benchmarking: Useful for quickly sweeping across different problem shapes and kernels, especially when integrating with existing Python codebases. However, it requires careful implementation to avoid common measurement traps.
    • NVIDIA Profiling Tools: For highly accurate measurements of kernel characteristics, use tools provided in the CUDA Toolkit, such as:
      • Nsight CUDA Profiling Tools Interface (cupti)
      • Nsight Compute CLI (ncu)