Skip to content

Commit 06dd18d

Browse files
SimonSchubertSimonSchubert
committed
Add commands
1 parent be64444 commit 06dd18d

3 files changed

Lines changed: 266 additions & 0 deletions

File tree

‎assets/commands/ng-new.md‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# TLDR
2+
3+
**Create a new Angular workspace**
4+
5+
```ng new [my-app]```
6+
7+
**Create without prompts** using defaults
8+
9+
```ng new [my-app] --defaults```
10+
11+
**Create with routing enabled**
12+
13+
```ng new [my-app] --routing```
14+
15+
**Create with specific style format**
16+
17+
```ng new [my-app] --style [scss|sass|less|css]```
18+
19+
**Create without initial git repository**
20+
21+
```ng new [my-app] --skip-git```
22+
23+
**Create without installing dependencies**
24+
25+
```ng new [my-app] --skip-install```
26+
27+
**Create with strict mode** for enhanced type checking
28+
29+
```ng new [my-app] --strict```
30+
31+
**Create in dry-run mode** to preview changes
32+
33+
```ng new [my-app] --dry-run```
34+
35+
# SYNOPSIS
36+
37+
**ng** **new** [_name_] [_options_]
38+
39+
# PARAMETERS
40+
41+
_NAME_
42+
> Name for the new workspace and initial project.
43+
44+
**--routing**
45+
> Generate a routing module for the initial project.
46+
47+
**--style** _STYLE_
48+
> File extension for style files (css, scss, sass, less).
49+
50+
**--skip-git**
51+
> Do not initialize a git repository.
52+
53+
**--skip-install**
54+
> Do not install dependency packages.
55+
56+
**--skip-tests**
57+
> Do not generate spec files for the initial project.
58+
59+
**--strict**
60+
> Enable stricter type checking and bundle budgets.
61+
62+
**--defaults**
63+
> Disable interactive prompts and use default values.
64+
65+
**--dry-run**
66+
> Run through without making changes (preview mode).
67+
68+
**--prefix** _PREFIX_
69+
> Prefix for generated selectors (default: app).
70+
71+
**--package-manager** _PM_
72+
> Package manager to use (npm, yarn, pnpm, cnpm).
73+
74+
**--directory** _DIR_
75+
> Directory to create the workspace in.
76+
77+
**--inline-style**
78+
> Include styles inline in the component TS file.
79+
80+
**--inline-template**
81+
> Include template inline in the component TS file.
82+
83+
**--view-encapsulation** _MODE_
84+
> View encapsulation strategy (Emulated, None, ShadowDom).
85+
86+
**--ssr**
87+
> Configure the application for Server-Side Rendering.
88+
89+
**--help**
90+
> Display help information.
91+
92+
# DESCRIPTION
93+
94+
**ng new** creates a new Angular workspace and generates an initial application. It scaffolds the complete project structure including configuration files, source directories, and optionally installs npm dependencies.
95+
96+
The command sets up TypeScript configuration, Angular-specific settings in angular.json, and testing infrastructure with Karma and Jasmine. The generated workspace follows Angular best practices and conventions.
97+
98+
When run without the **--defaults** flag, the CLI prompts for routing preferences and stylesheet format. The **--strict** option enables additional TypeScript compiler checks, stricter bundle budgets, and lint rules for improved code quality.
99+
100+
# CAVEATS
101+
102+
Requires Node.js and Angular CLI installed globally (**npm install -g @angular/cli**). The workspace name must be a valid npm package name (lowercase, no spaces). Creating large workspaces with full dependency installation can take several minutes depending on network speed.
103+
104+
# HISTORY
105+
106+
The **ng new** command has been part of **Angular CLI** since its initial release in **2016**. It evolved alongside Angular, adding options for routing in Angular 4, strict mode in Angular 10, and SSR scaffolding in Angular 17. The command generates standalone components by default since Angular 17.
107+
108+
# SEE ALSO
109+
110+
[ng](/man/ng)(1), [ng-generate](/man/ng-generate)(1), [ng-serve](/man/ng-serve)(1), [ng-build](/man/ng-build)(1)

‎assets/commands/noseyparker.md‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# TLDR
2+
3+
**Scan a local directory** for secrets
4+
5+
```noseyparker scan --datastore [db.np] [path/to/directory]```
6+
7+
**Scan a Git repository** by URL
8+
9+
```noseyparker scan --datastore [db.np] --git-url [https://github.com/user/repo]```
10+
11+
**Report findings** from a datastore
12+
13+
```noseyparker report --datastore [db.np]```
14+
15+
**Report in JSON format**
16+
17+
```noseyparker report --datastore [db.np] --format json```
18+
19+
**Scan with specific rules** only
20+
21+
```noseyparker scan --datastore [db.np] --rules [path/to/rules.yml] [path/to/directory]```
22+
23+
**List available built-in rules**
24+
25+
```noseyparker rules list```
26+
27+
**Summarize datastore contents**
28+
29+
```noseyparker summarize --datastore [db.np]```
30+
31+
# SYNOPSIS
32+
33+
**noseyparker** _command_ [_options_]
34+
35+
# PARAMETERS
36+
37+
**scan**
38+
> Scan inputs for secrets and store findings in a datastore.
39+
40+
**report**
41+
> Report findings from a datastore.
42+
43+
**summarize**
44+
> Summarize datastore contents without detailed findings.
45+
46+
**rules**
47+
> Manage and inspect detection rules.
48+
49+
**github**
50+
> Interact with GitHub for scanning repositories.
51+
52+
**--datastore** _PATH_
53+
> Path to the datastore (required for scan/report/summarize).
54+
55+
**--git-url** _URL_
56+
> Clone and scan a Git repository from URL.
57+
58+
**--format** _FORMAT_
59+
> Output format for report (human, json, jsonl, sarif).
60+
61+
**--rules** _PATH_
62+
> Path to custom rules file (YAML format).
63+
64+
**--max-file-size** _BYTES_
65+
> Skip files larger than specified size.
66+
67+
**--jobs** _N_
68+
> Number of parallel scanning jobs.
69+
70+
**--ignore** _PATTERN_
71+
> Glob patterns for paths to ignore.
72+
73+
**--blob-metadata**
74+
> Include blob metadata in findings.
75+
76+
**-h**, **--help**
77+
> Display help information.
78+
79+
**-V**, **--version**
80+
> Display version information.
81+
82+
# DESCRIPTION
83+
84+
**Nosey Parker** is a command-line tool for detecting secrets and sensitive information in textual data and Git repositories. It scans source code, configuration files, and commit history to find accidentally committed credentials, API keys, private keys, and other sensitive data.
85+
86+
The tool uses a datastore model where scan results are persisted to a local database, allowing incremental scanning and deduplication of findings. Multiple scans can feed into the same datastore, and reports can be generated at any time from the accumulated data.
87+
88+
Nosey Parker includes over 150 built-in detection rules covering common secret patterns like AWS keys, GitHub tokens, private SSH keys, database connection strings, and more. Custom rules can be defined in YAML format for organization-specific patterns.
89+
90+
The scanner is written in Rust for high performance and can process large codebases quickly. It performs content-aware scanning that understands Git history, examining all commits and branches rather than just the current state.
91+
92+
# CAVEATS
93+
94+
Scan results may include false positives that require manual review. The datastore must be specified for most operations and grows with accumulated findings. Scanning large repositories with full Git history can be memory-intensive. Some detection rules may not catch obfuscated or encoded secrets.
95+
96+
# HISTORY
97+
98+
Nosey Parker was created by **Praetorian** and released as open source in **2023**. It was designed as a modern alternative to tools like truffleHog and git-secrets, emphasizing performance and accuracy. The Rust implementation provides significant speed improvements over Python-based alternatives. Development continues actively with regular rule updates and feature additions.
99+
100+
# SEE ALSO
101+
102+
[git-secrets](/man/git-secrets)(1), [trufflehog](/man/trufflehog)(1), [gitleaks](/man/gitleaks)(1), [detect-secrets](/man/detect-secrets)(1)

‎assets/commands/run-help.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# TLDR
2+
3+
**Display help for a command**
4+
5+
```run-help [command]```
6+
7+
**Display help for a built-in**
8+
9+
```run-help cd```
10+
11+
**Display help for an external command**
12+
13+
```run-help grep```
14+
15+
**Invoke help while typing** (default binding)
16+
17+
> Press **ESC h** or **Alt+h** at the command line
18+
19+
# SYNOPSIS
20+
21+
**run-help** [_command_]
22+
23+
# PARAMETERS
24+
25+
_COMMAND_
26+
> The command, built-in, or function to get help for.
27+
28+
# DESCRIPTION
29+
30+
**run-help** is a Zsh function that provides context-sensitive help for commands. When invoked, it determines the type of command and displays the appropriate documentation, whether from man pages, built-in help, or function definitions.
31+
32+
By default in Zsh, **run-help** is bound to **ESC h** (or **Alt+h**), allowing quick access to help while typing a command. The function intelligently handles different command types: it shows man pages for external commands, Zsh documentation for built-ins, and function source for shell functions.
33+
34+
The standard Zsh distribution includes helper functions like **run-help-git**, **run-help-ip**, **run-help-openssl**, and **run-help-sudo** that provide subcommand-aware help for complex commands. These must be autoloaded to be available.
35+
36+
To enable enhanced run-help functionality in Zsh, add to your .zshrc:
37+
38+
```
39+
autoload -Uz run-help
40+
unalias run-help 2>/dev/null
41+
alias help=run-help
42+
```
43+
44+
# CAVEATS
45+
46+
In some Zsh configurations, run-help is aliased to man by default, losing its intelligent behavior. The **unalias run-help** command removes this alias to restore full functionality. Helper functions for specific commands (run-help-git, etc.) must be autoloaded separately. The function relies on man pages being installed for external command documentation.
47+
48+
# HISTORY
49+
50+
**run-help** has been part of Zsh since early versions, providing an integrated help system within the shell. The function evolved to support modular helpers for complex commands with subcommands. It reflects Zsh's philosophy of providing rich, context-aware user assistance directly from the command line.
51+
52+
# SEE ALSO
53+
54+
[man](/man/man)(1), [help](/man/help)(1), [info](/man/info)(1), [whatis](/man/whatis)(1), [apropos](/man/apropos)(1)

0 commit comments

Comments
 (0)