nextflow.cli.CmdHelp.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nextflow Show documentation

A DSL modelled around the UNIX pipe concept, that simplifies writing parallel and scalable pipelines in a portable manner

There is a newer version: 24.11.0-edge

Show newest version

/*
 * Copyright 2013-2024, Seqera Labs
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package nextflow.cli
import com.beust.jcommander.Parameter
import com.beust.jcommander.Parameters
import groovy.transform.CompileStatic
/**
 * CLI sub-command HELP
 *
 * @author Paolo Di Tommaso 
 */
@CompileStatic
@Parameters(commandDescription = "Print the usage help for a command")
class CmdHelp extends CmdBase {

    static final public NAME = 'help'

    @Override
    final String getName() { NAME }

    @Parameter(description = 'command name', arity = 1)
    List args

    private UsageAware getUsage( List args ) {
        def result = args ? launcher.findCommand(args[0]) : null
        result instanceof UsageAware ? result as UsageAware: null
    }

    @Override
    void run() {
        def cmd = getUsage(args)
        if( cmd ) {
            cmd.usage(args.size()>1 ? args[1..-1] : Collections.emptyList())
        }
        else {
            launcher.usage(args ? args[0] : null)
        }
    }
}