{"id":15062346,"url":"https://github.com/perlpunk/app-appspec-p5","last_synced_at":"2025-04-10T14:22:00.068Z","repository":{"id":56832701,"uuid":"46626371","full_name":"perlpunk/App-AppSpec-p5","owner":"perlpunk","description":"Command line utility for working with App::Spec files ","archived":false,"fork":false,"pushed_at":"2022-11-21T01:49:46.000Z","size":292,"stargazers_count":6,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T13:04:10.867Z","etag":null,"topics":["command-line","completion","perl5","shell"],"latest_commit_sha":null,"homepage":"https://metacpan.org/pod/distribution/App-AppSpec/lib/appspec.pod","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/perlpunk.png","metadata":{"files":{"readme":"README.md","changelog":"Changes","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-21T17:47:31.000Z","updated_at":"2022-04-03T16:23:36.000Z","dependencies_parsed_at":"2022-09-08T01:11:47.426Z","dependency_job_id":null,"html_url":"https://github.com/perlpunk/App-AppSpec-p5","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perlpunk%2FApp-AppSpec-p5","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perlpunk%2FApp-AppSpec-p5/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perlpunk%2FApp-AppSpec-p5/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perlpunk%2FApp-AppSpec-p5/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/perlpunk","download_url":"https://codeload.github.com/perlpunk/App-AppSpec-p5/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248233935,"owners_count":21069493,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","completion","perl5","shell"],"created_at":"2024-09-24T23:34:39.642Z","updated_at":"2025-04-10T14:22:00.050Z","avatar_url":"https://github.com/perlpunk.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# appspec - A Tool for generating pod documentation and shell completion\n\n`appspec` is a tool working with specifications for command line tools. These\nspecifications are typically written in YAML.\n\nThe specification for `appspec` itself can be found in\n[`share/appspec-spec.yaml`](share/appspec-spec.yaml).\n\nIt supports commands with and without subcommands, short (`-v`) and\nlong options (`--version`) and nested subcommands.\n\nFor completion you can specify a static list of values, or you can call an\nexternal command.\nIf your program is written in perl and using App::Spec itself, you can also\nadd a callback to your program. which allows quite intelligent completion.\n\n## Usage\n\n    appspec help\n\n    # Generate completion\n    appspec completion program.yaml --bash \u003eprogram.bash\n    appspec completion program.yaml --zsh \u003e_program\n\n    # Generate pod documentation\n    appspec pod program.yaml program.pod\n    # You could then use pod2man to create a manpage from it\n    # pod2man program.pod ...\n\n    # Generate a new perl App::Spec commandline tool skeleton\n    appspec help new\n    appspec new --name myprogram --class My::Program My-Program\n\n## Examples\n\nYou can see a list of examples in my completion collection\n[https://github.com/perlpunk/shell-completions].\n\nIn the [`jq`\nfile](https://github.com/perlpunk/shell-completions/blob/master/specs/jq.yaml)\nyou will see a simple example of a static list of values:\n\n    - name: indent\n      type: integer\n      enum: [1,2,3,4,5,6,7,8]\n      summary: indent output using given number of spaces\n\nIn the [`mpath`\nfile](https://github.com/perlpunk/shell-completions/blob/master/specs/mpath.yaml)\nyou can find an example of how to call an external command:\n\n    parameters:\n    - name: module\n      summary: Module names\n      multiple: true\n      type: string\n      completion:\n        command_string: |\n          perl -E'use ExtUtils::Installed;say for ExtUtils::Installed-\u003enew(skip_cwd=\u003e1)-\u003emodules'\n\n## Installation\n\nThis is a perl tool. In order to use it, you either need to install it from\nCPAN, or try the standalone version.\n\nIt should work for any perl version 5.10 or higher.\n\n### CPAN installation\n\nYou need to install the CPAN module App::AppSpec.\n\nThis can be done with the `cpan` or `cpanm` command:\n\n    % cpanm App::AppSpec\n    # or\n    % cpan App::AppSpec\n\nThe `cpanm` command might be easier since it doesn't require configuration.\nYou need to install `cpanminus` for that (e.g. `apt-get install cpanminus`).\n\n## Standalone version\n\nFor a standalone version of the script, checkout the `standalone` branch.\nThere you will find `bin/appspec`.\n\nIt currently requires perl 5.20 or higher, otherwise you will get an\nerror message.\n\n## Completion\n\nYou can find the shell completion files in the `share/completion` directory.\n\nThen you can complete like this:\n\n    appspec \u003cTAB\u003e\n    appspec completion -\u003cTAB\u003e\n    appspec completion --zsh file.yaml\n\n### bash\n\n    $ source share/completion/bash/appspec.bash\n\n### zsh\n\nAdd `path/to/share/completion/zsh` to your .zshrc before the compinit call:\n\n    fpath=('path/to/App-AppSpec-p5/share/completion/zsh' $fpath)\n\nand `exec zsh`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperlpunk%2Fapp-appspec-p5","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fperlpunk%2Fapp-appspec-p5","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperlpunk%2Fapp-appspec-p5/lists"}