cuelang.org/go@v0.10.1/pkg/tool/cli/cli.cue (about)

     1  // Copyright 2018 The CUE Authors
     2  // 
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  // 
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  // 
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package cli
    16  
    17  // Print sends text to the stdout of the current process.
    18  Print: {
    19  	$id: *"tool/cli.Print" | "print" // for backwards compatibility
    20  
    21  	// text is the text to be printed.
    22  	text: string
    23  }
    24  
    25  // Ask prompts the current console with a message and waits for input.
    26  //
    27  // Example:
    28  //     task: ask: cli.Ask({
    29  //         prompt:   "Are you okay?"
    30  //         response: bool
    31  //     })
    32  Ask: {
    33  	$id: "tool/cli.Ask"
    34  
    35  	// prompt sends this message to the output.
    36  	prompt: string
    37  
    38  	// response holds the user's response. If it is a boolean expression it
    39  	// will interpret the answer using textual yes/ no.
    40  	response: string | bool
    41  }