fsq-cli
v0.3.0
Published
oclif example Hello World CLI (ESM)
Downloads
6
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g fsq-cli
$ fsq COMMAND
running command...
$ fsq (--version)
fsq-cli/0.3.0 darwin-arm64 node-v20.8.1
$ fsq --help [COMMAND]
USAGE
$ fsq COMMAND
...
Commands
fsq help [COMMANDS]
fsq login
fsq plugins
fsq plugins:install PLUGIN...
fsq plugins:inspect PLUGIN...
fsq plugins:install PLUGIN...
fsq plugins:link PLUGIN
fsq plugins:uninstall PLUGIN...
fsq plugins reset
fsq plugins:uninstall PLUGIN...
fsq plugins:uninstall PLUGIN...
fsq plugins update
fsq search recommendations
fsq help [COMMANDS]
Display help for fsq.
USAGE
$ fsq help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for fsq.
See code: @oclif/plugin-help
fsq login
Authenticate with Foursquare and retrieve an access token.
USAGE
$ fsq login
DESCRIPTION
Authenticate with Foursquare and retrieve an access token.
See code: dist/commands/login.ts
fsq plugins
List installed plugins.
USAGE
$ fsq plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ fsq plugins
See code: @oclif/plugin-plugins
fsq plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ fsq plugins add plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ fsq plugins add
EXAMPLES
$ fsq plugins add myplugin
$ fsq plugins add https://github.com/someuser/someplugin
$ fsq plugins add someuser/someplugin
fsq plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ fsq 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
$ fsq plugins inspect myplugin
See code: @oclif/plugin-plugins
fsq plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ fsq plugins install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ fsq plugins add
EXAMPLES
$ fsq plugins install myplugin
$ fsq plugins install https://github.com/someuser/someplugin
$ fsq plugins install someuser/someplugin
See code: @oclif/plugin-plugins
fsq plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ fsq plugins link PLUGIN
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
$ fsq plugins link myplugin
See code: @oclif/plugin-plugins
fsq plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ fsq plugins remove plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ fsq plugins unlink
$ fsq plugins remove
EXAMPLES
$ fsq plugins remove myplugin
fsq plugins reset
Remove all user-installed and linked plugins.
USAGE
$ fsq plugins reset
See code: @oclif/plugin-plugins
fsq plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ fsq plugins uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ fsq plugins unlink
$ fsq plugins remove
EXAMPLES
$ fsq plugins uninstall myplugin
See code: @oclif/plugin-plugins
fsq plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ fsq plugins unlink plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ fsq plugins unlink
$ fsq plugins remove
EXAMPLES
$ fsq plugins unlink myplugin
fsq plugins update
Update installed plugins.
USAGE
$ fsq plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
fsq search recommendations
Get recommended venues based on the user's query and location.
USAGE
$ fsq search recommendations --v <value> [--query <value>] [--ll <value>] [--radius <value>] [--sw <value>] [--ne <value>]
[--near <value>] [--section <value>] [--categoryId <value>] [--novelty <value>] [--friendVisits <value>] [--time
<value>] [--day <value>] [--lastVenue <value>] [--openNow] [--price <value>] [--saved] [--sortByDistance]
[--sortByPopularity <value>] [--limit <value>] [--offset <value>] [--json]
FLAGS
--categoryId=<value> Comma-separated list of categories to limit results to.
--day=<value> Retrieve results for any day of the week.
--friendVisits=<value> Limit results to places the user's friends have or haven't been.
--json Output raw JSON response without interactive parsing
--lastVenue=<value> Venue ID to find venues users often visit after a given venue.
--limit=<value> Number of results to return.
--ll=<value> Latitude/longitude around which to retrieve place information.
--ne=<value> Northeast latitude/longitude of the required rectangle.
--near=<value> Name of a place in the world.
--novelty=<value> Limit results to places the user hasn't been or has been.
--offset=<value> Used to page through results.
--openNow Only include venues that are open now.
--price=<value> Comma separated list of price points.
--query=<value> String to be searched against venue tips, category, etc.
--radius=<value> Limit results to venues within this many meters of the specified location.
--saved Only include venues that the user has saved.
--section=<value> Category or property to limit results.
--sortByDistance Sort results by distance.
--sortByPopularity=<value> Sort results by popularity.
--sw=<value> Southwest latitude/longitude of the required rectangle.
--time=<value> Retrieve results for any time of day.
--v=<value> (required) API version date (e.g., 20231010)
DESCRIPTION
Get recommended venues based on the user's query and location.
EXAMPLES
$ fsq search:recommendations --v 20231010 --ll "41.8781,-87.6298"
$ fsq search:recommendations --v 20231010 --near "Chicago, IL"
See code: dist/commands/search/recommendations.ts