Repository navigation
ng <command> --help does not work #16241
Description
🐞 bug report
Affected Package
The issue is caused by package @angular/cli
Is this a regression?
not sure.
Description
Angular cli commands seems to be working, but the --help flag does not work in them in angular 8. It is suggested in the documentation in multiple places that it should.
🔬 Minimal Reproduction
(npm uninstall -g @angular/cli)
npm install -g @angular/cli@latest
ng generate --help
🔥 Exception or Error
forest@forest:~$ ng generate --help
An unhandled exception occurred: Unable to locate a workspace file for workspace path. See "/tmp/ng-s4wanw/angular-errors.log" for further details.
forest@forest:~$ cat /tmp/ng-MYDOue/angular-errors.log
[error] Error: Unable to locate a workspace file for workspace path.
at Object.readWorkspace (/home/forest/.nvm/versions/node/v12.3.1/lib/node_modules/@angular/cli/node_modules/@angular-devkit/core/src/workspace/core.js:74:19)
at async GenerateCommand._loadWorkspace (/home/forest/.nvm/versions/node/v12.3.1/lib/node_modules/@angular/cli/models/schematic-command.js:442:35)
at async GenerateCommand.initialize (/home/forest/.nvm/versions/node/v12.3.1/lib/node_modules/@angular/cli/models/schematic-command.js:40:9)
at async GenerateCommand.initialize (/home/forest/.nvm/versions/node/v12.3.1/lib/node_modules/@angular/cli/commands/generate-impl.js:12:9)
at async GenerateCommand.validateAndRun (/home/forest/.nvm/versions/node/v12.3.1/lib/node_modules/@angular/cli/models/command.js:124:9)
at async Object.runCommand (/home/forest/.nvm/versions/node/v12.3.1/lib/node_modules/@angular/cli/models/command-runner.js:186:24)
at async default_1 (/home/forest/.nvm/versions/node/v12.3.1/lib/node_modules/@angular/cli/lib/cli/index.js:54:31)forest@forest:~$ ^C
🌍 Your Environment
Angular Version:
Angular CLI: 8.3.19
Node: 12.3.1
OS: linux x64
Angular:
...
Package Version
------------------------------------------------------
@angular-devkit/architect 0.803.19
@angular-devkit/core 8.3.19
@angular-devkit/schematics 8.3.19
@schematics/angular 8.3.19
@schematics/update 0.803.19
rxjs 6.4.0
Activity
santoshyadavdev commentedon Nov 20, 2019
Are you trying to run this from inside a Angular project? Or globally , to use ng generate --help you need to be inside an Angular workspace. Let me know if that works, we can update the docs if needed.
KissBalazs commentedon Nov 20, 2019
Yep, that was the problem. Outside of an angular project,
ng new --helpworks,ng generate --helpdoes not. Inside they both works.Although this might be a source of misunderstanding. Using the --help flag produces a different error than using the command itself:
forest@forest:~/projects$ ng generateThe generate command requires to be run in an Angular project, but a project definition could not be found.forest@forest:~/projects$ ng generate --helpAn unhandled exception occurred: Unable to locate a workspace file for workspace path. See "/tmp/ng-QM4fsM/angular-errors.log" for further details.Best solution could be updating the error message a bit maybe. Thank you for the help!
santoshyadavdev commentedon Nov 20, 2019
That's a good suggestion @alan-agius4 what's your thought on this?
alan-agius4 commentedon Nov 20, 2019
We should fix this 😊
imrvasishtha commentedon May 5, 2020
Please try to update the docs also because it can create a problem for person like me who is new in angular. Thanks. cli#basic-workflow
kuncevic commentedon Oct 18, 2020
Oh I believe it is really confused people who just new to angular cli and might be a kinda blocker for some, so this
ng command --helpshould just workHere is the list of commands that does not work outside the angular project #19057:
refactor(@angular/cli): replace command line arguments parser
angular-automatic-lock-bot commentedon Apr 9, 2022
This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.
Read more about our automatic conversation locking policy.
This action has been performed automatically by a bot.