Giter Club home page Giter Club logo

Comments (3)

fwolfst avatar fwolfst commented on July 30, 2024

I am not sure whether I still support the wording of that issue - imho behaviour should be consistent across commands but I am not sure what the default behaviour should be. I am only a casual user only, so I'd love to see this in the documentation (and implemented) to get it into my cmd-muscles memory.

Basically, there are three options:

  1. If the command is about entities, default to a :list-like command - dokku apps (an dplugin) behaves like this as of dokku 0.8
  2. Default to :help - tbh this would be my preferred solution, but as said this might be motivated by the fact that unfortunately I dont have to use dokku everyday. Anyway it would be very friedly towards casual users.
  3. Unpredictable :) - like it is now.

Obviously, not all commands can behave the same way (one-off commands like :version or :help probably shouldnt), but for the "entity-related" commands like postgres, storage, apps, plugin(s?), certs, ...

The more I think of it, the more I'd like the "entity-type" commands to respond with help, if no subcommand is given and implement a :list subcommand.

On a different track, any dokku command: (note the colon) fails. And dokkumentation is misleading in some cases:

dokku certs
 !     `certs` is not a dokku command.
 !     See `dokku help` for a list of available commands.

where dokku help lists certs as command.

Should I open three issues on the main dokku repo for that? (1: "Missing API-convention: output of command without subcommand", 2) Command with trailing colon misbehaves, 3) [is like 1) if already agreed on implementation of :help as preferred default subcommand] , otherwise 'revisit not a dokku command'.

from dokku-postgres.

josegonzalez avatar josegonzalez commented on July 30, 2024

In the core, we are moving to the default command being an alias for the help subcommand. There are some where it's already a pseudo-report command, or alias for info.

The next release will fix the dokku help output and implement help as the default wherever there is no current default subcommand for a core plugin. When we already have a default subcommand that doesn't make sense - config is an example where it might - I've marked it as deprecated and will remove them in favor of a help alias whenever we do a 1.0.0.

from dokku-postgres.

fwolfst avatar fwolfst commented on July 30, 2024

Sounds like a good plan. I assume this will land in usage and plugin development style guide and this issue can be closed for now - to resurface when API changes stabilize. Thanks.

from dokku-postgres.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.