{"__v":3,"_id":"5586c1de867b5e0d0006c4d4","category":{"__v":2,"_id":"5586aedcd23ef40d00de6e95","pages":["5586c1d3f8942c0d00293ded","5586c1de867b5e0d0006c4d4"],"project":"5511b00d316c512300151ccf","version":"5511b00d316c512300151cd2","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-21T12:32:28.427Z","from_sync":false,"order":1,"slug":"cli-tool","title":"CLI tool"},"project":"5511b00d316c512300151ccf","user":"5511afda316c512300151cce","version":{"__v":11,"_id":"5511b00d316c512300151cd2","project":"5511b00d316c512300151ccf","createdAt":"2015-03-24T18:42:21.658Z","releaseDate":"2015-03-24T18:42:21.658Z","categories":["5511b00e316c512300151cd3","55462d123dca710d0046471b","55462d1e35b2240d008389f1","55462ee63dca710d0046471c","5586aedcd23ef40d00de6e95","5586aef0f8942c0d00293dd3","5586bc28867b5e0d0006c4bc","5586bce4f8942c0d00293ddf","5586c209f8942c0d00293def","5587d09eeb5f2421003f9781","558ba534cf331f23002046cf"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-21T13:53:34.773Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"Install a component in an existing project:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ ngx install [options] <component> [target-directory]\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n#### Options\n\n##### `-f, --force`\n\nOverwrite existing file(s).\n\n##### `-h, --help`\n\nOutput usage information.\n\n#### Arguments\n\n##### `<component>`\n\nComponent to install.\n \nFormat: `[<github-username>/]<github-repository-name>`\n\n- if only a `<github-repository-name>` is specified, `ngx-components/<github-repository-name>` is used\n\n##### `<target-directory>`\n\nWhere to install the component.\n\n- if no `target-directory` is specified, `src/components` is used\n\n#### Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"# Install ngx-components/angular-ui-router-component in src/components/angular-ui-router-component\\n$ ngx install angular-ui-router-component\\n\\n# Install ngx-components/angular-ui-router-component in src/components/homepage\\n$ ngx install angular-ui-router-component src/components/homepage\\n\\n# Install github-username/foo in src/components/foo\\n$ ngx install github-username/foo\\n\\n# Install github-username/foo in src/components/bar\\n$ ngx install github-username/foo in src/components/bar\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n## What's next?\n\n- [View a list of official component](https://github.com/ngx-components)\n- [Learn how to initialize a boilerplate to kickstart a project using `ngx-init`](doc:ngx-init)","excerpt":"","slug":"ngx-install","type":"basic","title":"ngx install"}
Install a component in an existing project: [block:code] { "codes": [ { "code": "$ ngx install [options] <component> [target-directory]", "language": "shell" } ] } [/block] #### Options ##### `-f, --force` Overwrite existing file(s). ##### `-h, --help` Output usage information. #### Arguments ##### `<component>` Component to install. Format: `[<github-username>/]<github-repository-name>` - if only a `<github-repository-name>` is specified, `ngx-components/<github-repository-name>` is used ##### `<target-directory>` Where to install the component. - if no `target-directory` is specified, `src/components` is used #### Examples [block:code] { "codes": [ { "code": "# Install ngx-components/angular-ui-router-component in src/components/angular-ui-router-component\n$ ngx install angular-ui-router-component\n\n# Install ngx-components/angular-ui-router-component in src/components/homepage\n$ ngx install angular-ui-router-component src/components/homepage\n\n# Install github-username/foo in src/components/foo\n$ ngx install github-username/foo\n\n# Install github-username/foo in src/components/bar\n$ ngx install github-username/foo in src/components/bar", "language": "shell" } ] } [/block] ## What's next? - [View a list of official component](https://github.com/ngx-components) - [Learn how to initialize a boilerplate to kickstart a project using `ngx-init`](doc:ngx-init)