{"_id":"55fd9c6f56d6990d00a6cab4","user":"54d64e31276f8e0d00feab94","version":{"_id":"55fd9c6d56d6990d00a6ca9d","project":"54d64e6b276f8e0d00feab95","__v":1,"createdAt":"2015-09-19T17:33:33.368Z","releaseDate":"2015-09-19T17:33:33.368Z","categories":["55fd9c6e56d6990d00a6ca9e","55fd9c6e56d6990d00a6ca9f","55fd9c6e56d6990d00a6caa0"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.4.0","version":"1.4.0"},"__v":2,"project":"54d64e6b276f8e0d00feab95","category":{"_id":"55fd9c6e56d6990d00a6ca9e","pages":["55fd9c6f56d6990d00a6cab2","55fd9c6f56d6990d00a6cab3","55fd9c6f56d6990d00a6cab4","55fd9c6f56d6990d00a6cab5","55fd9c6f56d6990d00a6cab6"],"version":"55fd9c6d56d6990d00a6ca9d","__v":1,"project":"54d64e6b276f8e0d00feab95","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-07T17:42:04.249Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-07T18:13:31.681Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"[--version](#-kick-v)\",\n    \"2-0\": \"[about](#-kick-about)\",\n    \"3-0\": \"[new](#-kick-new)\",\n    \"4-0\": \"[generate](#-kick-generate)\",\n    \"5-0\": \"[destroy](#-kick-destroy)\",\n    \"6-0\": \"[setup](#-kick-setup)\",\n    \"7-0\": \"[server](#-kick-setup)\",\n    \"8-0\": \"[server:tdd](#-kick-server-tdd)\",\n    \"9-0\": \"[build](#-kick-build)\",\n    \"10-0\": \"[test](#-kick-test)\",\n    \"12-0\": \"[upgrade](#-kick-upgrade)\",\n    \"0-1\": \"-v\",\n    \"3-1\": \"n\",\n    \"4-1\": \"g\",\n    \"5-1\": \"d\",\n    \"6-1\": \"set\",\n    \"7-1\": \"s\",\n    \"8-1\": \"s:tdd\",\n    \"9-1\": \"b\",\n    \"10-1\": \"t\",\n    \"12-1\": \"u\",\n    \"h-0\": \"Command\",\n    \"h-1\": \"Alias\",\n    \"h-2\": \"Description\",\n    \"2-2\": \"Displays useful information about the application\",\n    \"3-2\": \"Creates an AngularJS application\",\n    \"4-2\": \"Generates files and code for services, directives, filters, partials, states, and more\",\n    \"6-2\": \"Downloads npm packages\",\n    \"7-2\": \"Runs webpack-dev-server with auto-reload\",\n    \"8-2\": \"Runs webpack-dev-server with auto-reload along with karma\",\n    \"9-2\": \"Builds the application for production\",\n    \"10-2\": \"Runs the test suite (requires running grunt serve before to build the code)\",\n    \"12-2\": \"Checks for a new angular-kick version\",\n    \"5-2\": \"Destroys and removes files and code for services, directives, filters, partials states, and more\",\n    \"0-2\": \"Displays current angular-kick version\",\n    \"1-0\": \"[help](#-kick-help)\",\n    \"1-1\": \"h\",\n    \"1-2\": \"Shows available commands\",\n    \"2-1\": \"a\",\n    \"13-0\": \"[docs](#-kick-docs)\",\n    \"13-1\": \"\",\n    \"14-0\": \"[karma-debug](#-kick-karma-debug)\",\n    \"14-2\": \"Open karma debugger in browser\",\n    \"13-2\": \"Open documentation in browser\",\n    \"11-0\": \"[lint](#-kick-lint)\",\n    \"11-2\": \"Check code issues with ESLint\"\n  },\n  \"cols\": 3,\n  \"rows\": 15\n}\n[/block]\n# $ kick -v\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick --version\\n$ kick -v\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n# $ kick help\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick help [command]\\n$ kick h [command]\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n# $ kick about\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick about\\n$ kick a\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nWill output application name and version, AngularJS version, bower packages and their versions and the name of production build output directory.\n\n# $ kick new\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick new <application-name>\\n$ kick n <application-name>\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nIf an application with the same name already exists, angular-kick will ask you if you want to destroy it and create a new one from scratch.\n\n# $ kick generate\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick generate <type> [<args>]\\n$ kick g <type> [<args>]\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n# $ kick destroy\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick destroy <type> [<args>]\\n$ kick d <type> [<args>]\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nFor each entity you generate, there is a destroyer to rollback your changes:\n\n# $ kick setup\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick setup\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n# $ kick server\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick server [--<environment>]\\n$ kick s [--<environment>]\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Default environment is `development`\"\n}\n[/block]\n# $ kick server:tdd\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick server:tdd [--<environment>]\\n$ kick s:tdd [--<environment>]\\n$ kick ass [--<environment>]\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Default environment is `development`\"\n}\n[/block]\n# $ kick build\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick build [--<environment>]\\n$ kick b [--<environment>]\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Default environment is `production`\"\n}\n[/block]\n# $ kick test\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick test [--<environment>]\\n$ kick t [--<environment>]\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nThis will run all the tests once. Karma will be loaded from `karma-once.conf.js`\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Default environment is `development`\"\n}\n[/block]\n# $ kick test\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick lint\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nThis will run ESLint on your code once and output the results.\n\n# $ kick upgrade\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick upgrade\\n$ kick u\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nAfter running this command, angular-kick will check if there are any updates. If there are, it will ask you whether you want to install it.\n\nYou can always update angular-kick manually:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ npm update -g angular-kick\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n# $ kick docs\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick docs\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nOpen angular-kick documentation in browser (http://www.angular-kick.com)\n\n# $ kick karma-debug\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick karma-debug\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nOpen karma debugger in browser (http://localhost:9876)","excerpt":"","slug":"commands","type":"basic","title":"Commands"}
[block:parameters] { "data": { "0-0": "[--version](#-kick-v)", "2-0": "[about](#-kick-about)", "3-0": "[new](#-kick-new)", "4-0": "[generate](#-kick-generate)", "5-0": "[destroy](#-kick-destroy)", "6-0": "[setup](#-kick-setup)", "7-0": "[server](#-kick-setup)", "8-0": "[server:tdd](#-kick-server-tdd)", "9-0": "[build](#-kick-build)", "10-0": "[test](#-kick-test)", "12-0": "[upgrade](#-kick-upgrade)", "0-1": "-v", "3-1": "n", "4-1": "g", "5-1": "d", "6-1": "set", "7-1": "s", "8-1": "s:tdd", "9-1": "b", "10-1": "t", "12-1": "u", "h-0": "Command", "h-1": "Alias", "h-2": "Description", "2-2": "Displays useful information about the application", "3-2": "Creates an AngularJS application", "4-2": "Generates files and code for services, directives, filters, partials, states, and more", "6-2": "Downloads npm packages", "7-2": "Runs webpack-dev-server with auto-reload", "8-2": "Runs webpack-dev-server with auto-reload along with karma", "9-2": "Builds the application for production", "10-2": "Runs the test suite (requires running grunt serve before to build the code)", "12-2": "Checks for a new angular-kick version", "5-2": "Destroys and removes files and code for services, directives, filters, partials states, and more", "0-2": "Displays current angular-kick version", "1-0": "[help](#-kick-help)", "1-1": "h", "1-2": "Shows available commands", "2-1": "a", "13-0": "[docs](#-kick-docs)", "13-1": "", "14-0": "[karma-debug](#-kick-karma-debug)", "14-2": "Open karma debugger in browser", "13-2": "Open documentation in browser", "11-0": "[lint](#-kick-lint)", "11-2": "Check code issues with ESLint" }, "cols": 3, "rows": 15 } [/block] # $ kick -v [block:code] { "codes": [ { "code": "$ kick --version\n$ kick -v", "language": "shell" } ] } [/block] # $ kick help [block:code] { "codes": [ { "code": "$ kick help [command]\n$ kick h [command]", "language": "shell" } ] } [/block] # $ kick about [block:code] { "codes": [ { "code": "$ kick about\n$ kick a", "language": "shell" } ] } [/block] Will output application name and version, AngularJS version, bower packages and their versions and the name of production build output directory. # $ kick new [block:code] { "codes": [ { "code": "$ kick new <application-name>\n$ kick n <application-name>", "language": "shell" } ] } [/block] If an application with the same name already exists, angular-kick will ask you if you want to destroy it and create a new one from scratch. # $ kick generate [block:code] { "codes": [ { "code": "$ kick generate <type> [<args>]\n$ kick g <type> [<args>]", "language": "shell" } ] } [/block] # $ kick destroy [block:code] { "codes": [ { "code": "$ kick destroy <type> [<args>]\n$ kick d <type> [<args>]", "language": "shell" } ] } [/block] For each entity you generate, there is a destroyer to rollback your changes: # $ kick setup [block:code] { "codes": [ { "code": "$ kick setup", "language": "shell" } ] } [/block] # $ kick server [block:code] { "codes": [ { "code": "$ kick server [--<environment>]\n$ kick s [--<environment>]", "language": "shell" } ] } [/block] [block:callout] { "type": "info", "body": "Default environment is `development`" } [/block] # $ kick server:tdd [block:code] { "codes": [ { "code": "$ kick server:tdd [--<environment>]\n$ kick s:tdd [--<environment>]\n$ kick ass [--<environment>]", "language": "shell" } ] } [/block] [block:callout] { "type": "info", "body": "Default environment is `development`" } [/block] # $ kick build [block:code] { "codes": [ { "code": "$ kick build [--<environment>]\n$ kick b [--<environment>]", "language": "shell" } ] } [/block] [block:callout] { "type": "info", "body": "Default environment is `production`" } [/block] # $ kick test [block:code] { "codes": [ { "code": "$ kick test [--<environment>]\n$ kick t [--<environment>]", "language": "shell" } ] } [/block] This will run all the tests once. Karma will be loaded from `karma-once.conf.js` [block:callout] { "type": "info", "body": "Default environment is `development`" } [/block] # $ kick test [block:code] { "codes": [ { "code": "$ kick lint", "language": "text" } ] } [/block] This will run ESLint on your code once and output the results. # $ kick upgrade [block:code] { "codes": [ { "code": "$ kick upgrade\n$ kick u", "language": "shell" } ] } [/block] After running this command, angular-kick will check if there are any updates. If there are, it will ask you whether you want to install it. You can always update angular-kick manually: [block:code] { "codes": [ { "code": "$ npm update -g angular-kick", "language": "shell" } ] } [/block] # $ kick docs [block:code] { "codes": [ { "code": "$ kick docs", "language": "text" } ] } [/block] Open angular-kick documentation in browser (http://www.angular-kick.com) # $ kick karma-debug [block:code] { "codes": [ { "code": "$ kick karma-debug", "language": "text" } ] } [/block] Open karma debugger in browser (http://localhost:9876)