sourceloupe-cli
v0.0.2
Published
A CLI interface to SourceLoupe, the most excellent Apex Static Code Analysis tool built with tree-sitter
Readme
sourceloupe-cli
A CLI interface to SourceLoupe, the most excellent Apex Static Code Analysis tool built with tree-sitter
Usage
$ npm install -g sourceloupe-cli
$ sloupe COMMAND
running command...
$ sloupe (--version)
sourceloupe-cli/0.0.2 darwin-arm64 node-v22.14.0
$ sloupe --help [COMMAND]
USAGE
$ sloupe COMMAND
...Commands
sloupe help [COMMAND]sloupe pluginssloupe plugins add PLUGINsloupe plugins:inspect PLUGIN...sloupe plugins install PLUGINsloupe plugins link PATHsloupe plugins remove [PLUGIN]sloupe plugins resetsloupe plugins uninstall [PLUGIN]sloupe plugins unlink [PLUGIN]sloupe plugins updatesloupe scan
sloupe help [COMMAND]
Display help for sloupe.
USAGE
$ sloupe 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 sloupe.See code: @oclif/plugin-help
sloupe plugins
List installed plugins.
USAGE
$ sloupe plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ sloupe pluginsSee code: @oclif/plugin-plugins
sloupe plugins add PLUGIN
Installs a plugin into sloupe.
USAGE
$ sloupe 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 sloupe.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SLOUPE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SLOUPE_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ sloupe plugins add
EXAMPLES
Install a plugin from npm registry.
$ sloupe plugins add myplugin
Install a plugin from a github url.
$ sloupe plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ sloupe plugins add someuser/somepluginsloupe plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ sloupe 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
$ sloupe plugins inspect mypluginSee code: @oclif/plugin-plugins
sloupe plugins install PLUGIN
Installs a plugin into sloupe.
USAGE
$ sloupe 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 sloupe.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SLOUPE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SLOUPE_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ sloupe plugins add
EXAMPLES
Install a plugin from npm registry.
$ sloupe plugins install myplugin
Install a plugin from a github url.
$ sloupe plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ sloupe plugins install someuser/somepluginSee code: @oclif/plugin-plugins
sloupe plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ sloupe 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
$ sloupe plugins link mypluginSee code: @oclif/plugin-plugins
sloupe plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ sloupe 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
$ sloupe plugins unlink
$ sloupe plugins remove
EXAMPLES
$ sloupe plugins remove mypluginsloupe plugins reset
Remove all user-installed and linked plugins.
USAGE
$ sloupe 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
sloupe plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ sloupe 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
$ sloupe plugins unlink
$ sloupe plugins remove
EXAMPLES
$ sloupe plugins uninstall mypluginSee code: @oclif/plugin-plugins
sloupe plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ sloupe 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
$ sloupe plugins unlink
$ sloupe plugins remove
EXAMPLES
$ sloupe plugins unlink mypluginsloupe plugins update
Update installed plugins.
USAGE
$ sloupe plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
sloupe scan
This command executes the scanner on the specified directory
USAGE
$ sloupe scan -d <value> [-n <value>...] [-c <value>...] [-r <value>]
FLAGS
-c, --category=<value>... only execute rules matching by category
-d, --directory=<value> (required) directory to scan
-n, --name=<value>... only execute rules matching by name
-r, --formatter=<value> [default: Csv] formatter to use for output
DESCRIPTION
This command executes the scanner on the specified directory
EXAMPLES
$ sloupe scan -d ./src -f "no-console" -f "no-debugger"See code: src/commands/scan.ts
