question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

DX: Commands should be listed alphabetically in help

See original GitHub issue

This is a Bug Report

Description

Commands should be listed alphabetically when running sls --help

  • What went wrong? Not all commands are listed in alphabetical order.
hyper

Additional Data

  • Serverless Framework Version: 1.15.3
  • Operating System: OSX 10.12.4

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Reactions:1
  • Comments:11 (11 by maintainers)

github_iconTop GitHub Comments

3reactions
brianneislercommented, Jun 12, 2017

Currently the commands are listed by the order of their definition. This leads to the commands being grouped by their defining plugins implicitly.

@HyperBrain good insights as usual 👍

I’m not sure that the plugin based ordering is immediately obvious to the greater chunk of the user base (mainly because they’re unaware that plugins and commands are related until they’ve really dug in to the code). I’ve seen this a few times now watching new users of the framework explore the commands. Their comments are “hey, your commands are out of order”

What if we’d add a sort option to the help command, with alphabetic being the default.

I like this as being an option. Potentially it would be nice to have them displayed under plugin headers. This seems like a feature that power users would get the most use out of, specifically plugin authors and framework maintainers.

Maybe something to this effect?

Commands by plugin

AwsConfigCredentials
  config credentials ............ Configures a new provider profile for the Serverless Framework

Config
  config ........................ Configure Serverless

Create
  create ........................ Create new Serverless service

Deploy
  deploy ........................ Deploy a Serverless service
  deploy function ............... Deploy a single function from the service
  deploy list ................... List deployed version of your Serverless Service
  deploy list functions ......... List all the deployed functions and their versions

Info
  info .......................... Display information about the service

Install
  install ....................... Install a Serverless service from GitHub

Invoke
  invoke ........................ Invoke a deployed function
  invoke local .................. Invoke function locally

Login
  login ......................... Login or sign up for the Serverless Platform
  logout ........................ Logout from the Serverless Platform 

Logs
  logs .......................... Output the logs of a deployed function

Metrics
  metrics ....................... Show metrics for a specific function

Package
  package ....................... Packages a Serverless service

Remove
  remove ........................ Remove Serverless service and all resources

Rollback
  rollback ...................... Rollback the Serverless service to a specific deployment
  rollback function ............. Rollback the function to the previous version

SlStats
  slstats ....................... Enable or disable stats
1reaction
pmuenscommented, Jun 21, 2017

I would like to work on this, if no one else is already working on it 😊

Awesome @darkowlzz 👍 Thanks for offering help here.

Let us know if you need any assistance!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Index of dx commands - DNAnexus Documentation
This page contains the help messages for each of the commands under dx, grouped by their primary category.
Read more >
CCC Commands
SET/GRID, Turns on DX Grid, toggles CQ Zone, ITU Zone, & US State to off ... WHO, This command will return a list...
Read more >
Chapter 3: Linux Commands
For help in locating commands, see the index at the back of this book. We've tried to be as thorough as possible in...
Read more >
For - Looping commands - Windows CMD - SS64.com
If the clause results in a multiple values then extra parameters are implicitly defined to hold each. These are automatically assigned in alphabetical...
Read more >
User's Guide for the amsmath Package (Version 2.1)
You can use the \\[⟨dimension⟩] command to get extra vertical space between lines in all the amsmath displayed equation environments, as is usual...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found