ts-pkgx/dist/packages/terraform-docsio.d.ts

A library & CLI for managing packages

/**
 * **terraform-docs** - Generate documentation from Terraform modules in various output formats
 *
 * @domain `terraform-docs.io`
 * @programs `terraform-docs`
 * @version `0.20.0` (5 versions available)
 * @versions From newest version to oldest.
 *
 * @install `launchpad install terraform-docs`
 * @aliases `terraform-docs`
 *
 * @example
 * ```typescript
 * import { pantry } from 'ts-pkgx'
 *
 * // Access via alias (recommended)
 * const pkg = pantry.terraformdocs
 * // Or access via domain
 * const samePkg = pantry.terraformdocsio
 * console.log(pkg === samePkg) // true
 * console.log(pkg.name)        // "terraform-docs.io"
 * console.log(pkg.description) // "Generate documentation from Terraform modules i..."
 * console.log(pkg.programs)    // ["terraform-docs"]
 * console.log(pkg.versions[0]) // "0.20.0" (latest)
 * ```
 *
 * @see https://ts-pkgx.netlify.app/packages/terraform-docs-io.md
 * @see https://ts-pkgx.netlify.app/usage
 */
export declare const terraformdocsPackage: {
  /**
   * The display name of this package.
   */
  name: 'terraform-docs.io';
  /**
   * The canonical domain name for this package.
   */
  domain: 'terraform-docs.io';
  /**
   * Brief description of what this package does.
   */
  description: 'Generate documentation from Terraform modules in various output formats';
  packageYmlUrl: 'https://github.com/pkgxdev/pantry/tree/main/projects/terraform-docs.io/package.yml';
  homepageUrl: '';
  githubUrl: 'https://github.com/pkgxdev/pantry/';
  /**
   * Command to install this package using launchpad.
   * @example launchpad install package-name
   */
  installCommand: 'launchpad install terraform-docs';
  /**
   * Executable programs provided by this package.
   * These can be run after installation.
   */
  programs: readonly ['terraform-docs'];
  companions: readonly [];
  dependencies: readonly [];
  /**
   * Available versions from newest to oldest.
   * @see https://ts-pkgx.netlify.app/usage for installation instructions
   */
  versions: readonly ['0.20.0', '0.19.0', '0.18.0', '0.17.0', '0.16.0'];
  /**
   * Alternative names for this package.
   * You can use any of these names to access the package.
   */
  aliases: readonly ['terraform-docs']
};
export type TerraformdocsPackage = typeof terraformdocsPackage