Skip to content
/ cli Public

MyAsk CLI allows users to interact with the MyAsk API directly from their local command line massively streamlining programmer workflow

License

Apache-2.0 license
1 star 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

MyAsk-IO/cli

BranchesTags

Repository files navigation

MyAsk CLI

MyAsk CLI allows users to interact with the MyAsk API directly from their local command line massively streamlining programmer workflow

MyAsk Logo

oclif Version Downloads/week

Usage

$ npm install -g @myask-io/cli
$ myask COMMAND
running command...
$ myask (--version)
@myask-io/cli/0.0.3 darwin-arm64 node-v22.14.0
$ myask --help [COMMAND]
USAGE
  $ myask COMMAND
...

Commands

myask api:invitation:create [EMAIL]

Send MyAsk invitation to a new user.

USAGE
  $ myask api:invitation:create [EMAIL]

ARGUMENTS
  EMAIL  Email of the user to invite to MyAsk

DESCRIPTION
  Send MyAsk invitation to a new user.

See code: src/commands/api/invitation/create.ts

myask api:invitation:list

Show sent MyAsk invitations.

USAGE
  $ myask api:invitation:list

DESCRIPTION
  Show sent MyAsk invitations.

See code: src/commands/api/invitation/list.ts

myask api:project:create

Create new project in MyAsk API

USAGE
  $ myask api:project:create [--name <value>] [--description <value>]

FLAGS
  --description=<value>  Project description
  --name=<value>         Project name

DESCRIPTION
  Create new project in MyAsk API

See code: src/commands/api/project/create.ts

myask api:project:delete [PROJECTID]

Delete MyAsk project

USAGE
  $ myask api:project:delete [PROJECTID] [--list] [-p <value>]

ARGUMENTS
  PROJECTID  ID of project to delete

FLAGS
  -p, --projectId=<value>  ID of project to delete
      --list               List projects and select to delete

DESCRIPTION
  Delete MyAsk project

See code: src/commands/api/project/delete.ts

myask api:project:set

List users projects and set active project in MyAsk config.

USAGE
  $ myask api:project:set

DESCRIPTION
  List users projects and set active project in MyAsk config.

See code: src/commands/api/project/set.ts

myask api:project:show [PROJECTID]

Show information for MyAsk project

USAGE
  $ myask api:project:show [PROJECTID] [--list] [-p <value>]

ARGUMENTS
  PROJECTID  ID of project to display

FLAGS
  -p, --projectId=<value>  ID of project to display
      --list               List projects and select to view

DESCRIPTION
  Show information for MyAsk project

See code: src/commands/api/project/show.ts

myask api:project:update

Update project information in MyAsk API

USAGE
  $ myask api:project:update

DESCRIPTION
  Update project information in MyAsk API

See code: src/commands/api/project/update.ts

myask api:question:delete [QUESTIONID]

Delete MyAsk question

USAGE
  $ myask api:question:delete [QUESTIONID] [--list] [-p <value>]

ARGUMENTS
  QUESTIONID  ID of question to delete

FLAGS
  -p, --questionId=<value>  ID of question to delete
      --list                List questions and select to delete

DESCRIPTION
  Delete MyAsk question

See code: src/commands/api/question/delete.ts

myask api:question:show [QUESTIONID]

Show details for MyAsk question

USAGE
  $ myask api:question:show [QUESTIONID] [--list] [-q <value>] [-s]

ARGUMENTS
  QUESTIONID  ID of question to display

FLAGS
  -q, --questionId=<value>  ID of question to display
  -s, --skipResponse        Do not include question response in output
      --list                List questions and select to view

DESCRIPTION
  Show details for MyAsk question

See code: src/commands/api/question/show.ts

myask config

View current or set new MyAsk configuration values.

USAGE
  $ myask config [-h <value>] [-t <value>]

FLAGS
  -h, --host=<value>   Set API base URL
  -t, --token=<value>  Set MyAsk API key

DESCRIPTION
  View current or set new MyAsk configuration values.

See code: src/commands/config.ts

myask help [COMMAND]

Display help for myask.

USAGE
  $ myask 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 myask.

See code: @oclif/plugin-help

myask info

Display current project and configuration information.

USAGE
  $ myask info

DESCRIPTION
  Display current project and configuration information.

See code: src/commands/info.ts

myask init

Initialize MyAsk CLI.

USAGE
  $ myask init

DESCRIPTION
  Initialize MyAsk CLI.

See code: src/commands/init.ts

myask plugins

List installed plugins.

USAGE
  $ myask plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ myask plugins

See code: @oclif/plugin-plugins

myask plugins:add PLUGIN

Installs a plugin into myask.

USAGE
  $ myask 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 myask.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the MYASK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the MYASK_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ myask plugins:add

EXAMPLES
  Install a plugin from npm registry.

    $ myask plugins:add myplugin

  Install a plugin from a github url.

    $ myask plugins:add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ myask plugins:add someuser/someplugin

myask plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ myask 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
  $ myask plugins:inspect myplugin

See code: @oclif/plugin-plugins

myask plugins:install PLUGIN

Installs a plugin into myask.

USAGE
  $ myask 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 myask.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the MYASK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the MYASK_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ myask plugins:add

EXAMPLES
  Install a plugin from npm registry.

    $ myask plugins:install myplugin

  Install a plugin from a github url.

    $ myask plugins:install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ myask plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

myask plugins:link PATH

Links a plugin into the CLI for development.

USAGE
  $ myask 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
  $ myask plugins:link myplugin

See code: @oclif/plugin-plugins

myask plugins:remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ myask 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
  $ myask plugins:unlink
  $ myask plugins:remove

EXAMPLES
  $ myask plugins:remove myplugin

myask plugins:reset

Remove all user-installed and linked plugins.

USAGE
  $ myask 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

myask plugins:uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ myask 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
  $ myask plugins:unlink
  $ myask plugins:remove

EXAMPLES
  $ myask plugins:uninstall myplugin

See code: @oclif/plugin-plugins

myask plugins:unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ myask 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
  $ myask plugins:unlink
  $ myask plugins:remove

EXAMPLES
  $ myask plugins:unlink myplugin

myask plugins:update

Update installed plugins.

USAGE
  $ myask plugins:update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

myask prompt [PROMPT]

Send a prompt to MyAsk API and retrieve a response.

USAGE
  $ myask prompt [PROMPT] [-p <value>] [-F <value>...] [-c <value>...]

ARGUMENTS
  PROMPT  Prompt to send

FLAGS
  -F, --inputFile=<value>...   Path to source file(s). (multiple)
  -c, --contextIds=<value>...  Comma-separated list of context question IDs
  -p, --prompt=<value>         Prompt to send

DESCRIPTION
  Send a prompt to MyAsk API and retrieve a response.

EXAMPLES
  $ myask prompt -p "How do I add ActiveAdmin to a Rails 7 app?"

  $ myask prompt -p "Refactor this file" -F path/to/src/file.ts

  $ myask prompt -F path/to/input.txt

  $ myask prompt -p "Help me combine these files:" -F path/to/file1.ts -F path/to/file2.ts

  $ myask prompt -p "Analyze this code" -c 123,456,789

See code: src/commands/prompt.ts

About

MyAsk CLI allows users to interact with the MyAsk API directly from their local command line massively streamlining programmer workflow

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages