secu-scan
v0.0.0
Published
scans owasp vulnerabilties
Readme
secu-scan
scans owasp vulnerabilties
Usage
$ npm install -g secu-scan
$ secu-scan COMMAND
running command...
$ secu-scan (--version)
secu-scan/0.0.0 win32-x64 node-v20.19.4
$ secu-scan --help [COMMAND]
USAGE
$ secu-scan COMMAND
...Commands
secu-scan configsecu-scan hello PERSONsecu-scan hello worldsecu-scan help [COMMAND]secu-scan installsecu-scan pluginssecu-scan plugins add PLUGINsecu-scan plugins:inspect PLUGIN...secu-scan plugins install PLUGINsecu-scan plugins link PATHsecu-scan plugins remove [PLUGIN]secu-scan plugins resetsecu-scan plugins uninstall [PLUGIN]secu-scan plugins unlink [PLUGIN]secu-scan plugins updatesecu-scan scan
secu-scan config
Configure Gemini API key for security scanning
USAGE
$ secu-scan config [-k <value>] [-s]
FLAGS
-k, --key=<value> Gemini API key
-s, --show Show current API key (masked)
DESCRIPTION
Configure Gemini API key for security scanning
EXAMPLES
$ secu-scan config --key YOUR_API_KEY
$ secu-scan config --showSee code: src/commands/config/index.ts
secu-scan hello PERSON
Say hello
USAGE
$ secu-scan hello PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ secu-scan hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)See code: src/commands/hello/index.ts
secu-scan hello world
Say hello world
USAGE
$ secu-scan hello world
DESCRIPTION
Say hello world
EXAMPLES
$ secu-scan hello world
hello world! (./src/commands/hello/world.ts)See code: src/commands/hello/world.ts
secu-scan help [COMMAND]
Display help for secu-scan.
USAGE
$ secu-scan help [COMMAND...] [-n]
ARGUMENTS
[COMMAND...] Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for secu-scan.See code: @oclif/plugin-help
secu-scan install
Install pre-commit hook in your git repository
USAGE
$ secu-scan install [-p <value>]
FLAGS
-p, --path=<value> Path to git repository (defaults to current directory)
DESCRIPTION
Install pre-commit hook in your git repository
EXAMPLES
$ secu-scan install
$ secu-scan install --path /path/to/repoSee code: src/commands/install.ts
secu-scan plugins
List installed plugins.
USAGE
$ secu-scan plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ secu-scan pluginsSee code: @oclif/plugin-plugins
secu-scan plugins add PLUGIN
Installs a plugin into secu-scan.
USAGE
$ secu-scan plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into secu-scan.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SECU_SCAN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SECU_SCAN_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ secu-scan plugins add
EXAMPLES
Install a plugin from npm registry.
$ secu-scan plugins add myplugin
Install a plugin from a github url.
$ secu-scan plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ secu-scan plugins add someuser/somepluginsecu-scan plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ secu-scan plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ secu-scan plugins inspect mypluginSee code: @oclif/plugin-plugins
secu-scan plugins install PLUGIN
Installs a plugin into secu-scan.
USAGE
$ secu-scan plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into secu-scan.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SECU_SCAN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SECU_SCAN_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ secu-scan plugins add
EXAMPLES
Install a plugin from npm registry.
$ secu-scan plugins install myplugin
Install a plugin from a github url.
$ secu-scan plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ secu-scan plugins install someuser/somepluginSee code: @oclif/plugin-plugins
secu-scan plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ secu-scan plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ secu-scan plugins link mypluginSee code: @oclif/plugin-plugins
secu-scan plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ secu-scan plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ secu-scan plugins unlink
$ secu-scan plugins remove
EXAMPLES
$ secu-scan plugins remove mypluginsecu-scan plugins reset
Remove all user-installed and linked plugins.
USAGE
$ secu-scan plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.See code: @oclif/plugin-plugins
secu-scan plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ secu-scan plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ secu-scan plugins unlink
$ secu-scan plugins remove
EXAMPLES
$ secu-scan plugins uninstall mypluginSee code: @oclif/plugin-plugins
secu-scan plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ secu-scan plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ secu-scan plugins unlink
$ secu-scan plugins remove
EXAMPLES
$ secu-scan plugins unlink mypluginsecu-scan plugins update
Update installed plugins.
USAGE
$ secu-scan plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
secu-scan scan
Manually scan repository for OWASP top 10 vulnerabilities
USAGE
$ secu-scan scan [-s] [-a]
FLAGS
-a, --all Scan all files in repository
-s, --staged Scan only staged changes (like pre-commit hook)
DESCRIPTION
Manually scan repository for OWASP top 10 vulnerabilities
EXAMPLES
$ secu-scan scan
$ secu-scan scan --staged
$ secu-scan scan --allSee code: src/commands/scan/index.ts
