@alexgorbatchev/dotfiles 0.0.6 → 0.0.10

package/skill/references/installation-methods/github-release.md

@@ -5,9 +5,9 @@ Download and install tools from GitHub releases with automatic platform asset se
 ## Basic Usage
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
-export default defineTool((install) => install('github-release', { repo: 'junegunn/fzf' }).bin('fzf'));
+export default defineTool((install) => install("github-release", { repo: "junegunn/fzf" }).bin("fzf"));
 ```
 
 ## Parameters
@@ -28,31 +28,31 @@ export default defineTool((install) => install('github-release', { repo: 'junegu
 ### With Asset Pattern
 
 ```typescript
-install('github-release', {
-  repo: 'sharkdp/bat',
-  assetPattern: '*linux_amd64.tar.gz',
-}).bin('bat');
+install("github-release", {
+  repo: "sharkdp/bat",
+  assetPattern: "*linux_amd64.tar.gz",
+}).bin("bat");
 ```
 
 ### Custom Asset Selector
 
 ```typescript
-install('github-release', {
-  repo: 'example/tool',
+install("github-release", {
+  repo: "example/tool",
   assetSelector: ({ assets, systemInfo }) => {
-    const platform = systemInfo.platform === 'darwin' ? 'macos' : systemInfo.platform;
+    const platform = systemInfo.platform === "darwin" ? "macos" : systemInfo.platform;
     return assets.find((a) => a.name.includes(platform));
   },
-}).bin('tool');
+}).bin("tool");
 ```
 
 ### Specific Version
 
 ```typescript
-install('github-release', {
-  repo: 'owner/tool',
-  version: 'v2.1.0',
-}).bin('tool');
+install("github-release", {
+  repo: "owner/tool",
+  version: "v2.1.0",
+}).bin("tool");
 ```
 
 ### Using gh CLI
@@ -60,10 +60,10 @@ install('github-release', {
 Use the `gh` CLI for API requests instead of fetch. Useful when working behind proxies or leveraging existing `gh` authentication:
 
 ```typescript
-install('github-release', {
-  repo: 'owner/tool',
+install("github-release", {
+  repo: "owner/tool",
   ghCli: true,
-}).bin('tool');
+}).bin("tool");
 ```
 
 ### Including Prereleases
@@ -71,10 +71,10 @@ install('github-release', {
 By default, GitHub's "latest" excludes prereleases. Use `prerelease: true` for repos that only publish prerelease versions:
 
 ```typescript
-install('github-release', {
-  repo: 'owner/nightly-only-tool',
+install("github-release", {
+  repo: "owner/nightly-only-tool",
   prerelease: true,
-}).bin('tool');
+}).bin("tool");
 ```
 
 ## Asset Pattern Matching

package/skill/references/installation-methods/manual.md

@@ -5,29 +5,29 @@ Installs files from your tool configuration directory (custom scripts, pre-built
 ## Basic Usage
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 // Install a custom script
 export default defineTool((install, ctx) =>
-  install('manual', {
-    binaryPath: './scripts/my-tool.sh',
-  }).bin('my-tool')
+  install("manual", {
+    binaryPath: "./scripts/my-tool.sh",
+  }).bin("my-tool"),
 );
 
 // Without params (shell-only or dependency wrapper)
 export default defineTool((install) =>
-  install('manual')
-    .bin('tokscale')
-    .dependsOn('bun')
+  install("manual")
+    .bin("tokscale")
+    .dependsOn("bun")
     .zsh((shell) =>
       shell.functions({
         tokscale: `bun x tokscale@latest`,
-      })
-    )
+      }),
+    ),
 );
 
 // Configuration-only tool (no binary)
-export default defineTool((install, ctx) => install().zsh((shell) => shell.aliases({ ll: 'ls -la' })));
+export default defineTool((install, ctx) => install().zsh((shell) => shell.aliases({ ll: "ls -la" })));
 ```
 
 ## Parameters
@@ -43,27 +43,27 @@ export default defineTool((install, ctx) => install().zsh((shell) => shell.alias
 
 ```typescript
 export default defineTool((install, ctx) =>
-  install('manual', {
-    binaryPath: './binaries/linux/x64/custom-tool',
-  }).bin('custom-tool')
+  install("manual", {
+    binaryPath: "./binaries/linux/x64/custom-tool",
+  }).bin("custom-tool"),
 );
 ```
 
 ### Configuration-Only Tool
 
 ```typescript
-export default defineTool((install, ctx) => install().zsh((shell) => shell.aliases({ ll: 'ls -la', la: 'ls -A' })));
+export default defineTool((install, ctx) => install().zsh((shell) => shell.aliases({ ll: "ls -la", la: "ls -A" })));
 ```
 
 ### With Shell Configuration
 
 ```typescript
 export default defineTool((install, ctx) =>
-  install('manual', {
-    binaryPath: './bin/my-tool.sh',
+  install("manual", {
+    binaryPath: "./bin/my-tool.sh",
   })
-    .bin('my-tool')
-    .zsh((shell) => shell.aliases({ mt: 'my-tool' }).completions('./completions/_my-tool'))
+    .bin("my-tool")
+    .zsh((shell) => shell.aliases({ mt: "my-tool" }).completions("./completions/_my-tool")),
 );
 ```
 

package/skill/references/installation-methods/npm.md

@@ -5,9 +5,9 @@ Install tools published as npm packages. Supports both `npm` and `bun` as packag
 ## Basic Usage
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
-export default defineTool((install) => install('npm', { package: 'prettier' }).bin('prettier'));
+export default defineTool((install) => install("npm", { package: "prettier" }).bin("prettier"));
 ```
 
 ## Parameters
@@ -18,7 +18,7 @@ export default defineTool((install) => install('npm', { package: 'prettier' }).b
 | `version`        | `string`                                         | No       | Version or version range (e.g., `3.0.0`, defaults to latest)  |
 | `packageManager` | `'npm' \| 'bun'`                                 | No       | Package manager to use for installation (defaults to `'npm'`) |
 | `versionArgs`    | `string[]`                                       | No       | Arguments for version check (e.g., `['--version']`)           |
-| `versionRegex`   | `string`                                         | No       | Regex to extract version from output                          |
+| `versionRegex`   | `string \| RegExp`                               | No       | Regex to extract version from output                          |
 | `env`            | `Record<string, string> \| (ctx) => Record<...>` | No       | Environment variables (static or dynamic function)            |
 
 ## Examples
@@ -27,10 +27,10 @@ export default defineTool((install) => install('npm', { package: 'prettier' }).b
 
 ```typescript
 export default defineTool((install) =>
-  install('npm', {
-    package: 'prettier',
-    version: '3.0.0',
-  }).bin('prettier')
+  install("npm", {
+    package: "prettier",
+    version: "3.0.0",
+  }).bin("prettier"),
 );
 ```
 
@@ -38,10 +38,10 @@ export default defineTool((install) =>
 
 ```typescript
 export default defineTool((install) =>
-  install('npm', {
-    package: 'prettier',
-    packageManager: 'bun',
-  }).bin('prettier')
+  install("npm", {
+    package: "prettier",
+    packageManager: "bun",
+  }).bin("prettier"),
 );
 ```
 
@@ -49,9 +49,9 @@ export default defineTool((install) =>
 
 ```typescript
 export default defineTool((install) =>
-  install('npm', {
-    package: '@angular/cli',
-  }).bin('ng')
+  install("npm", {
+    package: "@angular/cli",
+  }).bin("ng"),
 );
 ```
 
@@ -59,11 +59,11 @@ export default defineTool((install) =>
 
 ```typescript
 export default defineTool((install) =>
-  install('npm', {
-    package: 'typescript',
-    versionArgs: ['--version'],
-    versionRegex: '(\\d+\\.\\d+\\.\\d+)',
-  }).bin('tsc')
+  install("npm", {
+    package: "typescript",
+    versionArgs: ["--version"],
+    versionRegex: /(\d+\.\d+\.\d+)/,
+  }).bin("tsc"),
 );
 ```
 

package/skill/references/installation-methods/overview.md

@@ -9,12 +9,12 @@ The system supports multiple installation methods to accommodate different tool
 Install tools from GitHub releases with automatic asset selection and extraction.
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
-  install('github-release', {
-    repo: 'owner/repository',
-  }).bin('tool')
+  install("github-release", {
+    repo: "owner/repository",
+  }).bin("tool"),
 );
 ```
 
@@ -23,13 +23,13 @@ export default defineTool((install, ctx) =>
 Install tools from Gitea, Forgejo, or Codeberg releases with automatic asset selection.
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
-  install('gitea-release', {
-    instanceUrl: 'https://codeberg.org',
-    repo: 'owner/repository',
-  }).bin('tool')
+  install("gitea-release", {
+    instanceUrl: "https://codeberg.org",
+    repo: "owner/repository",
+  }).bin("tool"),
 );
 ```
 
@@ -38,12 +38,12 @@ export default defineTool((install, ctx) =>
 Install tools using Homebrew package manager (macOS and Linux).
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
-  install('brew', {
-    formula: 'ripgrep',
-  }).bin('rg')
+  install("brew", {
+    formula: "ripgrep",
+  }).bin("rg"),
 );
 ```
 
@@ -52,12 +52,12 @@ export default defineTool((install, ctx) =>
 Install Rust tools from crates.io with cargo-quickinstall for faster downloads.
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
-  install('cargo', {
-    crateName: 'ripgrep',
-  }).bin('rg')
+  install("cargo", {
+    crateName: "ripgrep",
+  }).bin("rg"),
 );
 ```
 
@@ -66,12 +66,12 @@ export default defineTool((install, ctx) =>
 Install tools published as npm packages.
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
-  install('npm', {
-    package: 'prettier',
-  }).bin('prettier')
+  install("npm", {
+    package: "prettier",
+  }).bin("prettier"),
 );
 ```
 
@@ -80,13 +80,13 @@ export default defineTool((install, ctx) =>
 Download and execute installation scripts.
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
-  install('curl-script', {
-    url: 'https://bun.sh/install',
-    shell: 'bash',
-  }).bin('bun')
+  install("curl-script", {
+    url: "https://bun.sh/install",
+    shell: "bash",
+  }).bin("bun"),
 );
 ```
 
@@ -95,12 +95,12 @@ export default defineTool((install, ctx) =>
 Download and extract tarballs directly from URLs.
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
-  install('curl-tar', {
-    url: 'https://releases.example.com/tool-v1.0.0.tar.gz',
-  }).bin('tool')
+  install("curl-tar", {
+    url: "https://releases.example.com/tool-v1.0.0.tar.gz",
+  }).bin("tool"),
 );
 ```
 
@@ -109,12 +109,12 @@ export default defineTool((install, ctx) =>
 Download standalone binary files directly from URLs (no archive extraction).
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
-  install('curl-binary', {
-    url: 'https://example.com/tool-v1.0.0-linux-amd64',
-  }).bin('tool')
+  install("curl-binary", {
+    url: "https://example.com/tool-v1.0.0-linux-amd64",
+  }).bin("tool"),
 );
 ```
 
@@ -123,26 +123,26 @@ export default defineTool((install, ctx) =>
 Install macOS applications from DMG disk images into `/Applications` (silently skipped on other platforms).
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
-  install('dmg', {
+  install("dmg", {
     source: {
-      type: 'url',
-      url: 'https://example.com/MyApp-1.0.0.dmg',
+      type: "url",
+      url: "https://example.com/MyApp-1.0.0.dmg",
     },
-  })
+  }),
 );
 ```
 
 DMG also supports GitHub release sources:
 
 ```typescript
-install('dmg', {
+install("dmg", {
   source: {
-    type: 'github-release',
-    repo: 'manaflow-ai/cmux',
-    assetPattern: '*macos*.dmg',
+    type: "github-release",
+    repo: "manaflow-ai/cmux",
+    assetPattern: "*macos*.dmg",
   },
 });
 ```
@@ -152,29 +152,29 @@ install('dmg', {
 Install files from your dotfiles directory (custom scripts, pre-built binaries) or configuration-only tools. Can be called without params: `install('manual')`.
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 // With binary installation
 export default defineTool((install, ctx) =>
-  install('manual', {
-    binaryPath: './bin/my-script.sh',
-  }).bin('my-script')
+  install("manual", {
+    binaryPath: "./bin/my-script.sh",
+  }).bin("my-script"),
 );
 
 // Without params (shell-only or dependency wrapper)
 export default defineTool((install) =>
-  install('manual')
-    .bin('tokscale')
-    .dependsOn('bun')
+  install("manual")
+    .bin("tokscale")
+    .dependsOn("bun")
     .zsh((shell) =>
       shell.functions({
         tokscale: `bun x tokscale@latest`,
-      })
-    )
+      }),
+    ),
 );
 
 // Configuration-only
-export default defineTool((install, ctx) => install().zsh((shell) => shell.aliases({ ll: 'ls -la' })));
+export default defineTool((install, ctx) => install().zsh((shell) => shell.aliases({ ll: "ls -la" })));
 ```
 
 ### Zsh Plugin
@@ -182,13 +182,12 @@ export default defineTool((install, ctx) => install().zsh((shell) => shell.alias
 Clone Git repositories for zsh plugins.
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
-  install('zsh-plugin', {
-    repo: 'jeffreytse/zsh-vi-mode',
-  })
-    .zsh((shell) => shell.always(`source "${ctx.currentDir}/zsh-vi-mode.plugin.zsh"`))
+  install("zsh-plugin", {
+    repo: "jeffreytse/zsh-vi-mode",
+  }).zsh((shell) => shell.always(`source "${ctx.currentDir}/zsh-vi-mode.plugin.zsh"`)),
 );
 ```
 
@@ -222,12 +221,12 @@ The `manual` method is the unified approach for binary installation from your do
 **Example:** Including a custom deployment script with your dotfiles.
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
-  install('manual', {
-    binaryPath: './scripts/deploy.sh',
-  }).bin('deploy')
+  install("manual", {
+    binaryPath: "./scripts/deploy.sh",
+  }).bin("deploy"),
 );
 ```
 
@@ -241,18 +240,18 @@ export default defineTool((install, ctx) =>
 **Example:** Setting up shell aliases and environment variables.
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install, ctx) =>
   install().zsh((shell) =>
     shell
       .aliases({
-        ll: 'ls -la',
+        ll: "ls -la",
       })
       .env({
-        EDITOR: 'vim',
-      })
-  )
+        EDITOR: "vim",
+      }),
+  ),
 );
 ```
 
@@ -272,17 +271,17 @@ All installation methods support an `env` parameter for setting environment vari
 
 ```typescript
 // Static environment variables
-install('github-release', {
-  repo: 'owner/tool',
-  env: { CUSTOM_FLAG: 'true' },
-}).bin('tool');
+install("github-release", {
+  repo: "owner/tool",
+  env: { CUSTOM_FLAG: "true" },
+}).bin("tool");
 
 // Dynamic environment variables
-install('curl-script', {
-  url: 'https://example.com/install.sh',
-  shell: 'bash',
+install("curl-script", {
+  url: "https://example.com/install.sh",
+  shell: "bash",
   env: (ctx) => ({ INSTALL_DIR: ctx.stagingDir }),
-}).bin('tool');
+}).bin("tool");
 ```
 
 Dynamic `env` functions receive a context with:

package/skill/references/installation-methods/zsh-plugin.md

@@ -11,12 +11,12 @@ The `zsh-plugin` installation method clones Git repositories for zsh plugins and
 The simplest way to install a plugin from GitHub:
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install) =>
-  install('zsh-plugin', {
-    repo: 'jeffreytse/zsh-vi-mode',
-  })
+  install("zsh-plugin", {
+    repo: "jeffreytse/zsh-vi-mode",
+  }),
 );
 ```
 
@@ -27,12 +27,12 @@ The plugin is automatically sourced - no additional configuration needed!
 For plugins hosted elsewhere (GitLab, Bitbucket, private repos):
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install) =>
-  install('zsh-plugin', {
-    url: 'https://gitlab.com/user/custom-plugin.git',
-  })
+  install("zsh-plugin", {
+    url: "https://gitlab.com/user/custom-plugin.git",
+  }),
 );
 ```
 
@@ -59,13 +59,13 @@ By default (`auto: true`), zsh plugins are automatically installed during the `d
 To disable auto-installation and require explicit `dotfiles install`:
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install) =>
-  install('zsh-plugin', {
-    repo: 'jeffreytse/zsh-vi-mode',
+  install("zsh-plugin", {
+    repo: "jeffreytse/zsh-vi-mode",
     auto: false, // Requires explicit `dotfiles install`
-  })
+  }),
 );
 ```
 
@@ -74,13 +74,13 @@ export default defineTool((install) =>
 Use `pluginName` when you want the plugin directory name to differ from the repository name:
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install) =>
-  install('zsh-plugin', {
-    repo: 'jeffreytse/zsh-vi-mode',
-    pluginName: 'vi-mode', // Cloned to plugins/vi-mode instead of plugins/zsh-vi-mode
-  })
+  install("zsh-plugin", {
+    repo: "jeffreytse/zsh-vi-mode",
+    pluginName: "vi-mode", // Cloned to plugins/vi-mode instead of plugins/zsh-vi-mode
+  }),
 );
 ```
 
@@ -89,13 +89,13 @@ export default defineTool((install) =>
 If the plugin's source file doesn't follow standard naming conventions, specify it explicitly:
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install) =>
-  install('zsh-plugin', {
-    repo: 'some-org/some-plugin',
-    source: 'custom-init.zsh', // Use this file instead of auto-detection
-  })
+  install("zsh-plugin", {
+    repo: "some-org/some-plugin",
+    source: "custom-init.zsh", // Use this file instead of auto-detection
+  }),
 );
 ```
 
@@ -122,18 +122,17 @@ The installer checks for these files in order:
 Use `.zsh()` to add environment variables or other shell configuration:
 
 ```typescript
-import { defineTool } from '@alexgorbatchev/dotfiles';
+import { defineTool } from "@alexgorbatchev/dotfiles";
 
 export default defineTool((install) =>
-  install('zsh-plugin', {
-    repo: 'jeffreytse/zsh-vi-mode',
-  })
-    .zsh((shell) =>
-      shell.env({
-        ZVM_VI_INSERT_ESCAPE_BINDKEY: 'jj',
-        ZVM_CURSOR_STYLE_ENABLED: 'false',
-      })
-    )
+  install("zsh-plugin", {
+    repo: "jeffreytse/zsh-vi-mode",
+  }).zsh((shell) =>
+    shell.env({
+      ZVM_VI_INSERT_ESCAPE_BINDKEY: "jj",
+      ZVM_CURSOR_STYLE_ENABLED: "false",
+    }),
+  ),
 );
 ```