{"id":16296826,"url":"https://github.com/windomz/url-generator","last_synced_at":"2026-02-14T17:31:41.304Z","repository":{"id":57387542,"uuid":"92084082","full_name":"WindomZ/url-generator","owner":"WindomZ","description":"Generates URL address based on the directory.","archived":false,"fork":false,"pushed_at":"2020-06-01T02:02:09.000Z","size":2091,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-07T02:02:14.862Z","etag":null,"topics":["directory","generator","url","url-generate"],"latest_commit_sha":null,"homepage":"","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/WindomZ.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":"2017-05-22T18:08:44.000Z","updated_at":"2020-04-24T01:17:52.000Z","dependencies_parsed_at":"2022-09-26T16:50:53.003Z","dependency_job_id":null,"html_url":"https://github.com/WindomZ/url-generator","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/WindomZ%2Furl-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindomZ%2Furl-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindomZ%2Furl-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindomZ%2Furl-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WindomZ","download_url":"https://codeload.github.com/WindomZ/url-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247732512,"owners_count":20986879,"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":["directory","generator","url","url-generate"],"created_at":"2024-10-10T20:24:06.735Z","updated_at":"2026-02-14T17:31:41.261Z","avatar_url":"https://github.com/WindomZ.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# url-generator\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/WindomZ/url-generator.svg)](https://greenkeeper.io/)\n[![Build Status](https://travis-ci.org/WindomZ/url-generator.svg?branch=master)](https://travis-ci.org/WindomZ/url-generator)\n[![Coverage Status](https://coveralls.io/repos/github/WindomZ/url-generator/badge.svg?branch=master)](https://coveralls.io/github/WindomZ/url-generator?branch=master)\n[![Dependency](https://david-dm.org/WindomZ/url-generator.svg)](https://david-dm.org/WindomZ/url-generator)\n[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)\n\n\u003e Generates URL address based on the directory.\n\n[![NPM](https://nodei.co/npm/url-gen.png)](https://nodei.co/npm/url-gen/)\n\n[![url-gen](https://img.shields.io/npm/v/url-gen.svg)](https://www.npmjs.com/package/url-gen)\n[![status](https://img.shields.io/badge/status-stable-green.svg)](https://www.npmjs.com/package/url-gen)\n\n## Features\n\n- [x] _cli_ - Command line interface.\n- [x] _custom_ - Customize `.url-gen.yml` file.\n\n## Install\n\n```bash\nnpm install -g url-gen\n```\n\n## Usage\n\n```bash\n$ url-gen -h\n\n   USAGE\n\n     url-gen [dir]\n     url-gen init\n\n   ARGUMENTS\n\n     [dir]      Relative directory path to generate the URL      optional      default: \".\"\n\n   OPTIONS\n\n     -u, --up \u003clevel\u003e      Query \u003clevel\u003e parent directory      optional      default: 0\n\n   GLOBAL OPTIONS\n\n     -h, --help         Display help                                      \n     -V, --version      Display version                                   \n     --no-color         Disable colors                                    \n     --quiet            Quiet mode - only displays warn and error messages\n     -v, --verbose      Verbose mode - will also output debug messages\n```\n\n## Configuration\n\nYou need to customize the `.url-gen.yml` file, the rules configured like this: \n```yaml\nversion: 1.0               # version number, optional\nroot: http://127.0.0.1:888 # defines the url root path, optional, default: http://127.0.0.1\npath: example              # defines the url path of the current directory, optional\n```\n\nYou can run ``url-gen init`` to help create.\n\n## Example\n\n```bash\nurl-gen            # working in the local directory.\nurl-gen examples   # working in the `./examples/` directory.\nurl-gen ~/examples # working in the `~/examples/` directory.\n\nurl-gen i          # creates the `.url-gen.yml` file.\nurl-gen init       # creates the `.url-gen.yml` file.\n```\n\n## Environment\n\n- linux CI pass\n- macOS CI pass\n- windows Not yet tested\n\n## Contributing\n\nWelcome to pull requests, report bugs, suggest ideas and discuss **url-generator**, \ni would love to hear what you think about **url-generator** on [issues page](https://github.com/WindomZ/url-generator/issues).\n\nIf you like it then you can put a :star: on it.\n\n## License\n\n[MIT](https://github.com/WindomZ/url-generator/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindomz%2Furl-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwindomz%2Furl-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindomz%2Furl-generator/lists"}