ts-pkgx/dist/packages/tldrsh.d.ts

A library & CLI for managing packages

/**
 * **tldr** - C command-line client for tldr pages 📚
 *
 * @domain `tldr.sh`
 * @programs `tldr`
 * @version `1.6.1` (3 versions available)
 * @versions From newest version to oldest.
 *
 * @install `launchpad install tldr`
 * @name `tldr`
 * @dependencies `linux:sourceware.org/bzip2^1`, `curl.se` (includes OS-specific dependencies with `os:package` format)
 *
 * @example
 * ```typescript
 * import { pantry } from 'ts-pkgx'
 *
 * // Access the package
 * const pkg = pantry.tldr
 * // Or access via domain
 * const samePkg = pantry.tldrsh
 * console.log(pkg === samePkg) // true
 * console.log(pkg.name)        // "tldr"
 * console.log(pkg.description) // "C command-line client for tldr pages 📚"
 * console.log(pkg.programs)    // ["tldr"]
 * console.log(pkg.versions[0]) // "1.6.1" (latest)
 * ```
 *
 * @see https://ts-pkgx.netlify.app/packages/tldr-sh.md
 * @see https://ts-pkgx.netlify.app/usage
 */
export declare const tldrPackage: {
  /**
   * The display name of this package.
   */
  name: 'tldr';
  /**
   * The canonical domain name for this package.
   */
  domain: 'tldr.sh';
  /**
   * Brief description of what this package does.
   */
  description: 'C command-line client for tldr pages 📚';
  packageYmlUrl: 'https://github.com/pkgxdev/pantry/tree/main/projects/tldr.sh/package.yml';
  homepageUrl: '';
  githubUrl: 'https://github.com/pkgxdev/pantry/';
  /**
   * Command to install this package using launchpad.
   * @example launchpad install package-name
   */
  installCommand: 'launchpad install tldr';
  /**
   * Executable programs provided by this package.
   * These can be run after installation.
   */
  programs: readonly ['tldr'];
  companions: readonly [];
  /**
   * Required dependencies for this package.
   * These will be automatically installed.
   * OS-specific dependencies are prefixed with `os:` (e.g., `linux:freetype.org`).
   */
  dependencies: readonly ['linux:sourceware.org/bzip2^1', 'curl.se'];
  /**
   * Available versions from newest to oldest.
   * @see https://ts-pkgx.netlify.app/usage for installation instructions
   */
  versions: readonly ['1.6.1', '1.6.0', '1.5.0'];
  /**
   * Alternative names for this package.
   * You can use any of these names to access the package.
   */
  aliases: readonly [];
  pkgxInstallCommand: 'sh <(curl https://pkgx.sh) tldr -- $SHELL -i';
  launchpadInstallCommand: 'launchpad install tldr'
};
export type TldrPackage = typeof tldrPackage