Skip to content

Notify users and agents when a newer CLI version is available #90

Description

@ernestoongaro

Problem

Users who install the Omni CLI through Homebrew, the install script, or a downloaded binary are not told when a newer stable release is available. AI agents invoking the CLI non-interactively also have no stable way to discover and surface an available update.

Proposed behavior

Add a best-effort update check against the latest stable GitHub release.

Human/interactive use

  • Check at most once every 24 hours and cache the result in the user cache/state directory.

  • Run only when stdout and stderr are TTYs, outside CI, and the current build has a valid release version.

  • Use a short timeout; failures must be silent and must never fail or materially delay the requested command.

  • After a successful command, print a concise notice to stderr:

    A newer Omni CLI is available: v1.2.3 -> v1.3.0
    Homebrew: brew upgrade omni
    Other installs: https://github.com/exploreomni/cli#installation
    
  • If Homebrew is detected, allow a short grace period after release so the tap/core formula has time to update.

  • Support an opt-out such as OMNI_NO_UPDATE_NOTIFIER=1.

Agent/non-interactive use

Do not inject a human banner into normal JSON output. Preserve the current contract that API responses are JSON on stdout and errors are JSON on stderr.

  • Add an explicit command such as omni update check --format json that returns stable structured data including currentVersion, latestVersion, updateAvailable, releaseUrl, and suggested upgrade commands.
  • Document that command in omni agent-help.
  • Consider an opt-in environment variable (for example OMNI_AGENT_NOTICES=json) that emits a structured update notice on stderr after successful commands. Keep this opt-in because many automation tools treat any stderr output as a failure.
  • Never append an update notice to an API error document.

Example structured result:

{
"updateAvailable": true,
"currentVersion": "v1.2.3",
"latestVersion": "v1.3.0",
"releaseUrl": "https://github.com/exploreomni/cli/releases/tag/v1.3.0",
"upgrade": {
"homebrew": "brew upgrade omni",
"other": "re-run the installer or replace the binary"
}
}

Implementation notes

  • The release version is already embedded in the binary.
  • The install script already queries GitHub's latest-release endpoint.
  • The release workflow already publishes stable versions to the Homebrew tap.
  • Use semantic-version comparison and ignore prereleases unless the running build is on a prerelease channel.
  • Start the network check concurrently and cancel it when the primary command finishes if it has not completed, so update discovery does not add command latency.

Acceptance criteria

  • Interactive users see a notice no more than once per 24 hours when a newer stable version exists.
  • Homebrew and non-Homebrew upgrade guidance is correct.
  • Piped/JSON output and API error documents remain unchanged by default.
  • CI, development builds, disabled checks, timeouts, malformed responses, and network failures produce no notice and no command failure.
  • Agents have an explicit JSON command for checking update status.
  • Tests cover gating, caching, semantic version comparison, Homebrew guidance, timeout/failure behavior, and structured agent output.

Prior art

  • GitHub CLI checks once per 24 hours, requires stdout and stderr TTYs, skips CI, offers GH_NO_UPDATE_NOTIFIER, writes the notice to stderr, and delays Homebrew notices for 24 hours after publication.
  • Pulumi offers PULUMI_SKIP_UPDATE_CHECK and prints a reinstall command.
  • Terraform makes update checks optional and exposes both environment and config opt-outs.
  • Bun delegates upgrades to the package manager when it detects a package-manager installation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    , 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
     blocks
    (function() {
    function addCopyButtons() {
    document.querySelectorAll('pre code').forEach(function(codeBlock) {
    if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
    codeBlock.parentElement.setAttribute('data-copy-added', 'true');
    var btn = document.createElement('button');
    btn.textContent = 'Copy';
    btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
    btn.onmouseover = function() { this.style.opacity = '1'; };
    btn.onmouseout = function() { this.style.opacity = '0.7'; };
    btn.onclick = function() {
    navigator.clipboard.writeText(codeBlock.textContent).then(function() {
    btn.textContent = 'Copied!';
    setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
    });
    };
    codeBlock.parentElement.style.position = 'relative';
    codeBlock.parentElement.appendChild(btn);
    });
    }
    addCopyButtons();
    // Re-run on dynamic content
    var observer = new MutationObserver(addCopyButtons);
    observer.observe(document.body, { childList: true, subtree: true });
    })();
    }
    } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
    })();
    (function(){
    try {
    var __m = "github.com";
    var __re = new RegExp('^' + "github\\.com" + '
    Notify users and agents when a newer CLI version is available · Issue #90 · exploreomni/cli · GitHub
    Skip to content

    Notify users and agents when a newer CLI version is available #90

    Description

    @ernestoongaro

    Problem

    Users who install the Omni CLI through Homebrew, the install script, or a downloaded binary are not told when a newer stable release is available. AI agents invoking the CLI non-interactively also have no stable way to discover and surface an available update.

    Proposed behavior

    Add a best-effort update check against the latest stable GitHub release.

    Human/interactive use

    • Check at most once every 24 hours and cache the result in the user cache/state directory.

    • Run only when stdout and stderr are TTYs, outside CI, and the current build has a valid release version.

    • Use a short timeout; failures must be silent and must never fail or materially delay the requested command.

    • After a successful command, print a concise notice to stderr:

      A newer Omni CLI is available: v1.2.3 -> v1.3.0
      Homebrew: brew upgrade omni
      Other installs: https://github.com/exploreomni/cli#installation
      
    • If Homebrew is detected, allow a short grace period after release so the tap/core formula has time to update.

    • Support an opt-out such as OMNI_NO_UPDATE_NOTIFIER=1.

    Agent/non-interactive use

    Do not inject a human banner into normal JSON output. Preserve the current contract that API responses are JSON on stdout and errors are JSON on stderr.

    • Add an explicit command such as omni update check --format json that returns stable structured data including currentVersion, latestVersion, updateAvailable, releaseUrl, and suggested upgrade commands.
    • Document that command in omni agent-help.
    • Consider an opt-in environment variable (for example OMNI_AGENT_NOTICES=json) that emits a structured update notice on stderr after successful commands. Keep this opt-in because many automation tools treat any stderr output as a failure.
    • Never append an update notice to an API error document.

    Example structured result:

    {
    "updateAvailable": true,
    "currentVersion": "v1.2.3",
    "latestVersion": "v1.3.0",
    "releaseUrl": "https://github.com/exploreomni/cli/releases/tag/v1.3.0",
    "upgrade": {
    "homebrew": "brew upgrade omni",
    "other": "re-run the installer or replace the binary"
    }
    }
    

    Implementation notes

    • The release version is already embedded in the binary.
    • The install script already queries GitHub's latest-release endpoint.
    • The release workflow already publishes stable versions to the Homebrew tap.
    • Use semantic-version comparison and ignore prereleases unless the running build is on a prerelease channel.
    • Start the network check concurrently and cancel it when the primary command finishes if it has not completed, so update discovery does not add command latency.

    Acceptance criteria

    • Interactive users see a notice no more than once per 24 hours when a newer stable version exists.
    • Homebrew and non-Homebrew upgrade guidance is correct.
    • Piped/JSON output and API error documents remain unchanged by default.
    • CI, development builds, disabled checks, timeouts, malformed responses, and network failures produce no notice and no command failure.
    • Agents have an explicit JSON command for checking update status.
    • Tests cover gating, caching, semantic version comparison, Homebrew guidance, timeout/failure behavior, and structured agent output.

    Prior art

    • GitHub CLI checks once per 24 hours, requires stdout and stderr TTYs, skips CI, offers GH_NO_UPDATE_NOTIFIER, writes the notice to stderr, and delays Homebrew notices for 24 hours after publication.
    • Pulumi offers PULUMI_SKIP_UPDATE_CHECK and prints a reinstall command.
    • Terraform makes update checks optional and exposes both environment and config opt-outs.
    • Bun delegates upgrades to the package manager when it detects a package-manager installation.

    Metadata

    Metadata

    Assignees

    No one assigned

      Labels

      No labels
      No labels

      Type

      No type

      Projects

      No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      , 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Notify users and agents when a newer CLI version is available · Issue #90 · exploreomni/cli · GitHub
      Skip to content

      Notify users and agents when a newer CLI version is available #90

      Description

      @ernestoongaro

      Problem

      Users who install the Omni CLI through Homebrew, the install script, or a downloaded binary are not told when a newer stable release is available. AI agents invoking the CLI non-interactively also have no stable way to discover and surface an available update.

      Proposed behavior

      Add a best-effort update check against the latest stable GitHub release.

      Human/interactive use

      • Check at most once every 24 hours and cache the result in the user cache/state directory.

      • Run only when stdout and stderr are TTYs, outside CI, and the current build has a valid release version.

      • Use a short timeout; failures must be silent and must never fail or materially delay the requested command.

      • After a successful command, print a concise notice to stderr:

        A newer Omni CLI is available: v1.2.3 -> v1.3.0
        Homebrew: brew upgrade omni
        Other installs: https://github.com/exploreomni/cli#installation
        
      • If Homebrew is detected, allow a short grace period after release so the tap/core formula has time to update.

      • Support an opt-out such as OMNI_NO_UPDATE_NOTIFIER=1.

      Agent/non-interactive use

      Do not inject a human banner into normal JSON output. Preserve the current contract that API responses are JSON on stdout and errors are JSON on stderr.

      • Add an explicit command such as omni update check --format json that returns stable structured data including currentVersion, latestVersion, updateAvailable, releaseUrl, and suggested upgrade commands.
      • Document that command in omni agent-help.
      • Consider an opt-in environment variable (for example OMNI_AGENT_NOTICES=json) that emits a structured update notice on stderr after successful commands. Keep this opt-in because many automation tools treat any stderr output as a failure.
      • Never append an update notice to an API error document.

      Example structured result:

      {
      "updateAvailable": true,
      "currentVersion": "v1.2.3",
      "latestVersion": "v1.3.0",
      "releaseUrl": "https://github.com/exploreomni/cli/releases/tag/v1.3.0",
      "upgrade": {
      "homebrew": "brew upgrade omni",
      "other": "re-run the installer or replace the binary"
      }
      }
      

      Implementation notes

      • The release version is already embedded in the binary.
      • The install script already queries GitHub's latest-release endpoint.
      • The release workflow already publishes stable versions to the Homebrew tap.
      • Use semantic-version comparison and ignore prereleases unless the running build is on a prerelease channel.
      • Start the network check concurrently and cancel it when the primary command finishes if it has not completed, so update discovery does not add command latency.

      Acceptance criteria

      • Interactive users see a notice no more than once per 24 hours when a newer stable version exists.
      • Homebrew and non-Homebrew upgrade guidance is correct.
      • Piped/JSON output and API error documents remain unchanged by default.
      • CI, development builds, disabled checks, timeouts, malformed responses, and network failures produce no notice and no command failure.
      • Agents have an explicit JSON command for checking update status.
      • Tests cover gating, caching, semantic version comparison, Homebrew guidance, timeout/failure behavior, and structured agent output.

      Prior art

      • GitHub CLI checks once per 24 hours, requires stdout and stderr TTYs, skips CI, offers GH_NO_UPDATE_NOTIFIER, writes the notice to stderr, and delays Homebrew notices for 24 hours after publication.
      • Pulumi offers PULUMI_SKIP_UPDATE_CHECK and prints a reinstall command.
      • Terraform makes update checks optional and exposes both environment and config opt-outs.
      • Bun delegates upgrades to the package manager when it detects a package-manager installation.

      Metadata

      Metadata

      Assignees

      No one assigned

        Labels

        No labels
        No labels

        Type

        No type

        Projects

        No projects

        Milestone

        No milestone

        Relationships

        None yet

        Development

        No branches or pull requests

        Issue actions

        , 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Notify users and agents when a newer CLI version is available · Issue #90 · exploreomni/cli · GitHub
        Skip to content

        Notify users and agents when a newer CLI version is available #90

        Description

        @ernestoongaro

        Problem

        Users who install the Omni CLI through Homebrew, the install script, or a downloaded binary are not told when a newer stable release is available. AI agents invoking the CLI non-interactively also have no stable way to discover and surface an available update.

        Proposed behavior

        Add a best-effort update check against the latest stable GitHub release.

        Human/interactive use

        • Check at most once every 24 hours and cache the result in the user cache/state directory.

        • Run only when stdout and stderr are TTYs, outside CI, and the current build has a valid release version.

        • Use a short timeout; failures must be silent and must never fail or materially delay the requested command.

        • After a successful command, print a concise notice to stderr:

          A newer Omni CLI is available: v1.2.3 -> v1.3.0
          Homebrew: brew upgrade omni
          Other installs: https://github.com/exploreomni/cli#installation
          
        • If Homebrew is detected, allow a short grace period after release so the tap/core formula has time to update.

        • Support an opt-out such as OMNI_NO_UPDATE_NOTIFIER=1.

        Agent/non-interactive use

        Do not inject a human banner into normal JSON output. Preserve the current contract that API responses are JSON on stdout and errors are JSON on stderr.

        • Add an explicit command such as omni update check --format json that returns stable structured data including currentVersion, latestVersion, updateAvailable, releaseUrl, and suggested upgrade commands.
        • Document that command in omni agent-help.
        • Consider an opt-in environment variable (for example OMNI_AGENT_NOTICES=json) that emits a structured update notice on stderr after successful commands. Keep this opt-in because many automation tools treat any stderr output as a failure.
        • Never append an update notice to an API error document.

        Example structured result:

        {
        "updateAvailable": true,
        "currentVersion": "v1.2.3",
        "latestVersion": "v1.3.0",
        "releaseUrl": "https://github.com/exploreomni/cli/releases/tag/v1.3.0",
        "upgrade": {
        "homebrew": "brew upgrade omni",
        "other": "re-run the installer or replace the binary"
        }
        }
        

        Implementation notes

        • The release version is already embedded in the binary.
        • The install script already queries GitHub's latest-release endpoint.
        • The release workflow already publishes stable versions to the Homebrew tap.
        • Use semantic-version comparison and ignore prereleases unless the running build is on a prerelease channel.
        • Start the network check concurrently and cancel it when the primary command finishes if it has not completed, so update discovery does not add command latency.

        Acceptance criteria

        • Interactive users see a notice no more than once per 24 hours when a newer stable version exists.
        • Homebrew and non-Homebrew upgrade guidance is correct.
        • Piped/JSON output and API error documents remain unchanged by default.
        • CI, development builds, disabled checks, timeouts, malformed responses, and network failures produce no notice and no command failure.
        • Agents have an explicit JSON command for checking update status.
        • Tests cover gating, caching, semantic version comparison, Homebrew guidance, timeout/failure behavior, and structured agent output.

        Prior art

        • GitHub CLI checks once per 24 hours, requires stdout and stderr TTYs, skips CI, offers GH_NO_UPDATE_NOTIFIER, writes the notice to stderr, and delays Homebrew notices for 24 hours after publication.
        • Pulumi offers PULUMI_SKIP_UPDATE_CHECK and prints a reinstall command.
        • Terraform makes update checks optional and exposes both environment and config opt-outs.
        • Bun delegates upgrades to the package manager when it detects a package-manager installation.

        Metadata

        Metadata

        Assignees

        No one assigned

          Labels

          No labels
          No labels

          Type

          No type

          Projects

          No projects

          Milestone

          No milestone

          Relationships

          None yet

          Development

          No branches or pull requests

          Issue actions

          , 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Notify users and agents when a newer CLI version is available · Issue #90 · exploreomni/cli · GitHub
          Skip to content

          Notify users and agents when a newer CLI version is available #90

          Description

          @ernestoongaro

          Problem

          Users who install the Omni CLI through Homebrew, the install script, or a downloaded binary are not told when a newer stable release is available. AI agents invoking the CLI non-interactively also have no stable way to discover and surface an available update.

          Proposed behavior

          Add a best-effort update check against the latest stable GitHub release.

          Human/interactive use

          • Check at most once every 24 hours and cache the result in the user cache/state directory.

          • Run only when stdout and stderr are TTYs, outside CI, and the current build has a valid release version.

          • Use a short timeout; failures must be silent and must never fail or materially delay the requested command.

          • After a successful command, print a concise notice to stderr:

            A newer Omni CLI is available: v1.2.3 -> v1.3.0
            Homebrew: brew upgrade omni
            Other installs: https://github.com/exploreomni/cli#installation
            
          • If Homebrew is detected, allow a short grace period after release so the tap/core formula has time to update.

          • Support an opt-out such as OMNI_NO_UPDATE_NOTIFIER=1.

          Agent/non-interactive use

          Do not inject a human banner into normal JSON output. Preserve the current contract that API responses are JSON on stdout and errors are JSON on stderr.

          • Add an explicit command such as omni update check --format json that returns stable structured data including currentVersion, latestVersion, updateAvailable, releaseUrl, and suggested upgrade commands.
          • Document that command in omni agent-help.
          • Consider an opt-in environment variable (for example OMNI_AGENT_NOTICES=json) that emits a structured update notice on stderr after successful commands. Keep this opt-in because many automation tools treat any stderr output as a failure.
          • Never append an update notice to an API error document.

          Example structured result:

          {
          "updateAvailable": true,
          "currentVersion": "v1.2.3",
          "latestVersion": "v1.3.0",
          "releaseUrl": "https://github.com/exploreomni/cli/releases/tag/v1.3.0",
          "upgrade": {
          "homebrew": "brew upgrade omni",
          "other": "re-run the installer or replace the binary"
          }
          }
          

          Implementation notes

          • The release version is already embedded in the binary.
          • The install script already queries GitHub's latest-release endpoint.
          • The release workflow already publishes stable versions to the Homebrew tap.
          • Use semantic-version comparison and ignore prereleases unless the running build is on a prerelease channel.
          • Start the network check concurrently and cancel it when the primary command finishes if it has not completed, so update discovery does not add command latency.

          Acceptance criteria

          • Interactive users see a notice no more than once per 24 hours when a newer stable version exists.
          • Homebrew and non-Homebrew upgrade guidance is correct.
          • Piped/JSON output and API error documents remain unchanged by default.
          • CI, development builds, disabled checks, timeouts, malformed responses, and network failures produce no notice and no command failure.
          • Agents have an explicit JSON command for checking update status.
          • Tests cover gating, caching, semantic version comparison, Homebrew guidance, timeout/failure behavior, and structured agent output.

          Prior art

          • GitHub CLI checks once per 24 hours, requires stdout and stderr TTYs, skips CI, offers GH_NO_UPDATE_NOTIFIER, writes the notice to stderr, and delays Homebrew notices for 24 hours after publication.
          • Pulumi offers PULUMI_SKIP_UPDATE_CHECK and prints a reinstall command.
          • Terraform makes update checks optional and exposes both environment and config opt-outs.
          • Bun delegates upgrades to the package manager when it detects a package-manager installation.

          Metadata

          Metadata

          Assignees

          No one assigned

            Labels

            No labels
            No labels

            Type

            No type

            Projects

            No projects

            Milestone

            No milestone

            Relationships

            None yet

            Development

            No branches or pull requests

            Issue actions

            , 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Notify users and agents when a newer CLI version is available · Issue #90 · exploreomni/cli · GitHub
            Skip to content

            Notify users and agents when a newer CLI version is available #90

            Description

            @ernestoongaro

            Problem

            Users who install the Omni CLI through Homebrew, the install script, or a downloaded binary are not told when a newer stable release is available. AI agents invoking the CLI non-interactively also have no stable way to discover and surface an available update.

            Proposed behavior

            Add a best-effort update check against the latest stable GitHub release.

            Human/interactive use

            • Check at most once every 24 hours and cache the result in the user cache/state directory.

            • Run only when stdout and stderr are TTYs, outside CI, and the current build has a valid release version.

            • Use a short timeout; failures must be silent and must never fail or materially delay the requested command.

            • After a successful command, print a concise notice to stderr:

              A newer Omni CLI is available: v1.2.3 -> v1.3.0
              Homebrew: brew upgrade omni
              Other installs: https://github.com/exploreomni/cli#installation
              
            • If Homebrew is detected, allow a short grace period after release so the tap/core formula has time to update.

            • Support an opt-out such as OMNI_NO_UPDATE_NOTIFIER=1.

            Agent/non-interactive use

            Do not inject a human banner into normal JSON output. Preserve the current contract that API responses are JSON on stdout and errors are JSON on stderr.

            • Add an explicit command such as omni update check --format json that returns stable structured data including currentVersion, latestVersion, updateAvailable, releaseUrl, and suggested upgrade commands.
            • Document that command in omni agent-help.
            • Consider an opt-in environment variable (for example OMNI_AGENT_NOTICES=json) that emits a structured update notice on stderr after successful commands. Keep this opt-in because many automation tools treat any stderr output as a failure.
            • Never append an update notice to an API error document.

            Example structured result:

            {
            "updateAvailable": true,
            "currentVersion": "v1.2.3",
            "latestVersion": "v1.3.0",
            "releaseUrl": "https://github.com/exploreomni/cli/releases/tag/v1.3.0",
            "upgrade": {
            "homebrew": "brew upgrade omni",
            "other": "re-run the installer or replace the binary"
            }
            }
            

            Implementation notes

            • The release version is already embedded in the binary.
            • The install script already queries GitHub's latest-release endpoint.
            • The release workflow already publishes stable versions to the Homebrew tap.
            • Use semantic-version comparison and ignore prereleases unless the running build is on a prerelease channel.
            • Start the network check concurrently and cancel it when the primary command finishes if it has not completed, so update discovery does not add command latency.

            Acceptance criteria

            • Interactive users see a notice no more than once per 24 hours when a newer stable version exists.
            • Homebrew and non-Homebrew upgrade guidance is correct.
            • Piped/JSON output and API error documents remain unchanged by default.
            • CI, development builds, disabled checks, timeouts, malformed responses, and network failures produce no notice and no command failure.
            • Agents have an explicit JSON command for checking update status.
            • Tests cover gating, caching, semantic version comparison, Homebrew guidance, timeout/failure behavior, and structured agent output.

            Prior art

            • GitHub CLI checks once per 24 hours, requires stdout and stderr TTYs, skips CI, offers GH_NO_UPDATE_NOTIFIER, writes the notice to stderr, and delays Homebrew notices for 24 hours after publication.
            • Pulumi offers PULUMI_SKIP_UPDATE_CHECK and prints a reinstall command.
            • Terraform makes update checks optional and exposes both environment and config opt-outs.
            • Bun delegates upgrades to the package manager when it detects a package-manager installation.

            Metadata

            Metadata

            Assignees

            No one assigned

              Labels

              No labels
              No labels

              Type

              No type

              Projects

              No projects

              Milestone

              No milestone

              Relationships

              None yet

              Development

              No branches or pull requests

              Issue actions

              , 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); Notify users and agents when a newer CLI version is available · Issue #90 · exploreomni/cli · GitHub
              Skip to content

              Notify users and agents when a newer CLI version is available #90

              Description

              @ernestoongaro

              Problem

              Users who install the Omni CLI through Homebrew, the install script, or a downloaded binary are not told when a newer stable release is available. AI agents invoking the CLI non-interactively also have no stable way to discover and surface an available update.

              Proposed behavior

              Add a best-effort update check against the latest stable GitHub release.

              Human/interactive use

              • Check at most once every 24 hours and cache the result in the user cache/state directory.

              • Run only when stdout and stderr are TTYs, outside CI, and the current build has a valid release version.

              • Use a short timeout; failures must be silent and must never fail or materially delay the requested command.

              • After a successful command, print a concise notice to stderr:

                A newer Omni CLI is available: v1.2.3 -> v1.3.0
                Homebrew: brew upgrade omni
                Other installs: https://github.com/exploreomni/cli#installation
                
              • If Homebrew is detected, allow a short grace period after release so the tap/core formula has time to update.

              • Support an opt-out such as OMNI_NO_UPDATE_NOTIFIER=1.

              Agent/non-interactive use

              Do not inject a human banner into normal JSON output. Preserve the current contract that API responses are JSON on stdout and errors are JSON on stderr.

              • Add an explicit command such as omni update check --format json that returns stable structured data including currentVersion, latestVersion, updateAvailable, releaseUrl, and suggested upgrade commands.
              • Document that command in omni agent-help.
              • Consider an opt-in environment variable (for example OMNI_AGENT_NOTICES=json) that emits a structured update notice on stderr after successful commands. Keep this opt-in because many automation tools treat any stderr output as a failure.
              • Never append an update notice to an API error document.

              Example structured result:

              {
              "updateAvailable": true,
              "currentVersion": "v1.2.3",
              "latestVersion": "v1.3.0",
              "releaseUrl": "https://github.com/exploreomni/cli/releases/tag/v1.3.0",
              "upgrade": {
              "homebrew": "brew upgrade omni",
              "other": "re-run the installer or replace the binary"
              }
              }
              

              Implementation notes

              • The release version is already embedded in the binary.
              • The install script already queries GitHub's latest-release endpoint.
              • The release workflow already publishes stable versions to the Homebrew tap.
              • Use semantic-version comparison and ignore prereleases unless the running build is on a prerelease channel.
              • Start the network check concurrently and cancel it when the primary command finishes if it has not completed, so update discovery does not add command latency.

              Acceptance criteria

              • Interactive users see a notice no more than once per 24 hours when a newer stable version exists.
              • Homebrew and non-Homebrew upgrade guidance is correct.
              • Piped/JSON output and API error documents remain unchanged by default.
              • CI, development builds, disabled checks, timeouts, malformed responses, and network failures produce no notice and no command failure.
              • Agents have an explicit JSON command for checking update status.
              • Tests cover gating, caching, semantic version comparison, Homebrew guidance, timeout/failure behavior, and structured agent output.

              Prior art

              • GitHub CLI checks once per 24 hours, requires stdout and stderr TTYs, skips CI, offers GH_NO_UPDATE_NOTIFIER, writes the notice to stderr, and delays Homebrew notices for 24 hours after publication.
              • Pulumi offers PULUMI_SKIP_UPDATE_CHECK and prints a reinstall command.
              • Terraform makes update checks optional and exposes both environment and config opt-outs.
              • Bun delegates upgrades to the package manager when it detects a package-manager installation.

              Metadata

              Metadata

              Assignees

              No one assigned

                Labels

                No labels
                No labels

                Type

                No type

                Projects

                No projects

                Milestone

                No milestone

                Relationships

                None yet

                Development

                No branches or pull requests

                Issue actions