{"id":22428470,"url":"https://github.com/momsfriendlydevco/doop-cli","last_synced_at":"2025-03-27T06:43:53.081Z","repository":{"id":57215196,"uuid":"66606063","full_name":"MomsFriendlyDevCo/doop-cli","owner":"MomsFriendlyDevCo","description":"Doop CLI helper to perform unit based operations on the current project","archived":false,"fork":false,"pushed_at":"2017-10-08T21:50:45.000Z","size":40,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-25T12:50:53.505Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/MomsFriendlyDevCo.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":"2016-08-26T01:28:14.000Z","updated_at":"2016-08-26T01:29:00.000Z","dependencies_parsed_at":"2022-08-24T21:10:42.423Z","dependency_job_id":null,"html_url":"https://github.com/MomsFriendlyDevCo/doop-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Fdoop-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Fdoop-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Fdoop-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Fdoop-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MomsFriendlyDevCo","download_url":"https://codeload.github.com/MomsFriendlyDevCo/doop-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245798538,"owners_count":20673901,"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-12-05T20:14:54.454Z","updated_at":"2025-03-27T06:43:53.055Z","avatar_url":"https://github.com/MomsFriendlyDevCo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Doop-CLI\n========\nCommand Line Interface for the [Doop Framework](https://github.com/MomsFriendlyDevCo/Doop).\n\n```\n  Usage: doop [options] [command]\n\n\n  Commands:\n\n    config                    List Doop config\n    delete [unit]             Delete an exising unit from the project\n    gentest-schema [unit...]  Generate Mocha/Chai tests from unit schema files\n    glob [glob]               Glob for files within units and perform operations on them\n    install [unit...]         Install one or more units from the upstream Doop repo\n    list                      List units installed for the current project\n    make [unit]               Create a unit skeleton from the given name (plurals for unit names are recommended)\n    merge [unit]              Attempt to merge a unit with the upstream Doop repo\n    setup                     Configure Doop-Cli\n    help [cmd]                display help for [cmd]\n\n  Perform a Doop operation on the currently active project\n\n  Options:\n\n    -h, --help     output usage information\n    -V, --version  output the version number\n```\n\nGetting Started\n---------------\nInstall globally with NPM:\n\n```bash\nnpm install -g doop-cli\n```\n\nSetup the Doop-Cli\n\n```bash\ndoop setup\n```\n\nNavigate to your project root and, to list installed units in the project, run:\n\n```bash\ndoop list\n```\n\nConfiguration\n-------------\nThe `~/.dooprc` file is read for additional Doop settings. This file will be created with a basic layout when running `doop setup` for the first time.\n\nRun the `doop config` command for the current configuration.\n\n\n| Config path               | Type   | Default          | Description                                                                            |\n|---------------------------|--------|------------------|----------------------------------------------------------------------------------------|\n| `globs.projectRoot`       | string | `./package.json` | The glob to use to identify the project root                                           |\n| `globs.units`             | string | `./units/*/`     | Where to find a projects Units                                                         |\n| `paths.doopCli`           | string | Programatic      | The file path to the Doop CLI file (automatically determined by default)               |\n| `paths.doop`              | string | Null             | The path on disk of the master Doop repo                                               |\n| `paths.project`           | string | Programatic      | The path on disk of the current project (automatically determined by default)          |\n| `aliases`                 | Object | `{default: 'list', ls: 'list', i: 'install', 'rm': 'delete'}` | An object containing a list of valid [alias](#aliases) commands |\n| `tools`                   | Object | `{meld: 'meld {{{project.path}}} {{{doop.path}}}'}` | An object of available tools (used mainly to merge) |\n| `list.changes.maxEdited`  | number | `3`              | The maximum number of files to show per unit before compressing the list display       |\n| `list.changes.maxCreated` | number | `3`              | As with `list.changes.maxEdited` but for created files                                 |\n\n\nAliases\n-------\nDoop supports command line aliasing similar to Git. By specifying an alias you can provide a shortcut to the full command without constant repetion.\n\n* The meta `default` alias specifies what command to actually run if the CLI is run with no arguments\n* All commands are assumed to assume a `doop` prefix unless the alias begins with an exclaimation mark (to run the command as is)\n\n\nFor example setting the following in your `~/.dooprc` file will configure a selection of aliases:\n\n```ini\n[aliases]\ndefault=list\nls=list\ni=install\nrm=delete\nschm=glob *.schm.js\nstatus=!git status\n```\n\n* The `default` parameter tells Doop what to run if no command is specified (i.e. you run the CLI as just `doop` with no arguments).\n* Running `doop ls` will actually run `doop list`\n* Running `doop status` will run `git status`. The exclaimation mark prefix indicates that the command should be run as-is without an automatic `doop` prefix\n* Running `doop schm` will run `doop glob *.schm.js` files. Note that this will also carry any command line arguments automatically. For example `doop schm -e` will actually run `doop glob *.schm.js -e`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmomsfriendlydevco%2Fdoop-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmomsfriendlydevco%2Fdoop-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmomsfriendlydevco%2Fdoop-cli/lists"}