{"id":17836481,"url":"https://github.com/haysclark/cli-docs","last_synced_at":"2025-04-02T13:46:37.132Z","repository":{"id":57200005,"uuid":"47080874","full_name":"haysclark/cli-docs","owner":"haysclark","description":"Helper library for reading individual local text files for more scalable CLI documentation.","archived":false,"fork":false,"pushed_at":"2015-11-30T08:35:43.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-03-08T13:19:44.706Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/cli-docs","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/haysclark.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-29T21:23:53.000Z","updated_at":"2015-11-30T08:37:40.000Z","dependencies_parsed_at":"2022-09-16T15:01:36.002Z","dependency_job_id":null,"html_url":"https://github.com/haysclark/cli-docs","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haysclark%2Fcli-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haysclark%2Fcli-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haysclark%2Fcli-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haysclark%2Fcli-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/haysclark","download_url":"https://codeload.github.com/haysclark/cli-docs/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246827758,"owners_count":20840464,"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":[],"created_at":"2024-10-27T20:40:14.985Z","updated_at":"2025-04-02T13:46:37.112Z","avatar_url":"https://github.com/haysclark.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"cli-docs [![Build Status](https://travis-ci.org/haysclark/cli-docs.svg)](https://travis-ci.org/haysclark/cli-docs)[![Coverage Status](https://coveralls.io/repos/haysclark/cli-docs/badge.svg?branch=develop\u0026service=github)](https://coveralls.io/github/haysclark/cli-docs?branch=develop)[![npm version](https://badge.fury.io/js/cli-docs.svg)](http://badge.fury.io/js/cli-docs)\n========\n\nHelper library for reading individual local text files for more scalable CLI documentation.\n\n## Installation\n\n    npm install cli-docs --save-dev\n\n## Usage\n\nIn you CLI tool setup the service.\n\n    var docs = require('cli-docs')({\n        suffix: 'txt',     // file suffix for your docs\n        basepath: '../doc' // path to your docs\n    });\n\nTo read a docs file simply provide the name.\n\n    docs.read('example', function(err, data) {\n        console.log(data);\n    });\n\n## Development\n\n    npm install\n    npm link\n\n## Running tests\n\n    npm test\n    npm run coverage\n\n## Contributing\n\nIn lieu of a formal styleguide, take care to maintain the existing coding style.\nAdd unit tests for any new or changed functionality. Lint and test your code.\n\n## Release History\n\n* 0.0.1 bleeding edge\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaysclark%2Fcli-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaysclark%2Fcli-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaysclark%2Fcli-docs/lists"}