Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Basic app install and app update commands #249

Merged
merged 2 commits into from
Aug 3, 2022

Conversation

nblumhardt
Copy link
Member

seqcli app install [<args>]

Install an app package

Arguments:
      --package-id=VALUE     The package id of the app to install
      --version=VALUE        The package version to install; the default is to
                               install the latest version
      --feed-id=VALUE        The id of the NuGet feed to install the package
                               from; may be omitted if only one feed is
                               configured
  -s, --server=VALUE         The URL of the Seq server; by default the `
                               connection.serverUrl` config value will be used
  -a, --apikey=VALUE         The API key to use when connecting to the server;
                               by default the `connection.apiKey` config
                               value will be used
      --profile=VALUE        A connection profile to use; by default the `
                               connection.serverUrl` and `connection.apiKey`
                               config values will be used
      --json                 Print output in newline-delimited JSON (the
                               default is plain text)
      --no-color             Don't colorize text output
      --force-color          Force redirected output to have ANSI color (
                               unless `--no-color` is also specified)
      --verbose              Print verbose output to `STDERR`
seqcli app update [<args>]

Update an installed app package

Arguments:
  -i, --id=VALUE             The id of a single installed app to update
  -n, --name=VALUE           The name of the installed app to update
      --all                  Update all installed apps; not compatible with `-
                               i` or `-n`
      --version=VALUE        The package version to update to; the default is
                               to update to the latest version in the
                               associated feed
      --force                Update the app even if the target version is
                               already installed
  -s, --server=VALUE         The URL of the Seq server; by default the `
                               connection.serverUrl` config value will be used
  -a, --apikey=VALUE         The API key to use when connecting to the server;
                               by default the `connection.apiKey` config
                               value will be used
      --profile=VALUE        A connection profile to use; by default the `
                               connection.serverUrl` and `connection.apiKey`
                               config values will be used
      --json                 Print output in newline-delimited JSON (the
                               default is plain text)
      --no-color             Don't colorize text output
      --force-color          Force redirected output to have ANSI color (
                               unless `--no-color` is also specified)
      --verbose              Print verbose output to `STDERR`

Copy link
Contributor

@liammclennan liammclennan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some funny interactions for the update command. The user is supposed to specify exactly one of --id, --name, --all but this isn't clear.

What happens when the user specifies --all and --version is not likely to be what the user expects so I think this should be an error.

@nblumhardt
Copy link
Member Author

Thanks for the great review @liammclennan. I've updated the seqcli help <command> output to include an example - hopefully this improves the first issue you noted (providing more examples would definitely be nice here):

seqcli app install [<args>]

Install an app package

Example:
  seqcli app install --package-id 'Seq.App.JsonArchive'

Arguments:
      --package-id=VALUE     The package id of the app to install
      --version=VALUE        The package version to install; the default is to
                               install the latest version
      ... snip

I've added a check for _all and _version 👍

@nblumhardt
Copy link
Member Author

Thanks for the great review @liammclennan.

I've updated the help command output to now include examples for all commands, hopefully this improves on the first point, though we could definitely do more here 👍

seqcli app install [<args>]

Install an app package

Example:
  seqcli app install --package-id 'Seq.App.JsonArchive'

Arguments:
      --package-id=VALUE     The package id of the app to install
      --version=VALUE        The package version to install; the default is to
                               install the latest version
      --feed-id=VALUE        The id of the NuGet feed to install the package
                               from; may be omitted if only one feed is
                               configured
...

I've added a check to ensure that --all and --version are exclusive.

@nblumhardt nblumhardt merged commit 2400c6a into datalust:dev Aug 3, 2022
@nblumhardt nblumhardt mentioned this pull request Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants