├── go.mod ├── Taskfile.yml ├── .github └── workflows │ ├── golangci-lint.yml │ └── go-ci.yml ├── LICENSE ├── hooks └── commit-msg ├── example └── kurl │ ├── main.go │ └── get.go ├── LICENSE-MIT ├── README.md ├── cmder.go └── LICENSE-APACHE /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/hexops/cmder 2 | 3 | go 1.15 4 | -------------------------------------------------------------------------------- /Taskfile.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | 3 | tasks: 4 | default: 5 | cmds: 6 | - git config core.hooksPath hooks 7 | -------------------------------------------------------------------------------- /.github/workflows/golangci-lint.yml: -------------------------------------------------------------------------------- 1 | name: golangci-lint 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | lint: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - name: Checkout 10 | uses: actions/checkout@v2 11 | - name: golangci-lint 12 | uses: golangci/golangci-lint-action@v2 13 | with: 14 | version: v1.29 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2020, The Cmder Project Developers (given via the Git commit history). 2 | 3 | Licensed under the Apache License, Version 2.0 (see LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) 4 | or the MIT license (see LICENSE-MIT or http://opensource.org/licenses/MIT), at 5 | your option. All files in the project without exclusions may not be copied, 6 | modified, or distributed except according to those terms. 7 | -------------------------------------------------------------------------------- /.github/workflows/go-ci.yml: -------------------------------------------------------------------------------- 1 | name: Go CI 2 | on: 3 | - push 4 | jobs: 5 | test: 6 | runs-on: ubuntu-latest 7 | steps: 8 | - name: Checkout 9 | uses: actions/checkout@v2 10 | - name: Setup Go 11 | uses: actions/setup-go@v2 12 | with: 13 | go-version: ^1 14 | - run: go test ./... 15 | - run: go test -race -coverprofile=coverage.txt -covermode=atomic ./... 16 | - name: Upload code coverage 17 | uses: codecov/codecov-action@v1 18 | with: 19 | file: ./coverage.txt 20 | -------------------------------------------------------------------------------- /hooks/commit-msg: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # 3 | # Helper Git commit hook to ensure the DCO sign-off is present, to avoid 4 | # creating multiple commits without the DCO sign-off which is annoying to fix 5 | # and is required. 6 | # 7 | 8 | if ! grep -qE '^Signed-off-by: ' "$1"; then 9 | echo "Your commit message is not signed off with the DCO." >&2 10 | echo "" >&2 11 | echo "Please read and agree to the DCO: https://developercertificate.org/" >&2 12 | echo "" >&2 13 | echo "Hint: Use 'git commit -s' flag to sign your commits" >&2 14 | echo "" >&2 15 | echo "Hint: Use 'git commit -seF .git/COMMIT_EDITMSG' to recover your commit message and sign." >&2 16 | exit 1 17 | fi -------------------------------------------------------------------------------- /example/kurl/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "log" 6 | "os" 7 | 8 | "github.com/hexops/cmder" 9 | ) 10 | 11 | // commands contains all registered subcommands. 12 | var commands cmder.Commander 13 | 14 | // Our help text for this command. 15 | // Consult "go help" for inspiration on how to word yours. 16 | var usageText = `kurl is a tool that makes HTTP requests. 17 | 18 | Usage: 19 | 20 | kurl [arguments] 21 | 22 | The commands are: 23 | 24 | get perform HTTP GET requests 25 | 26 | Use "kurl -h" for more information about a command. 27 | ` 28 | 29 | func main() { 30 | // Configure logging if desired. 31 | log.SetFlags(0) 32 | log.SetPrefix("") 33 | 34 | commands.Run(flag.CommandLine, "kurl", usageText, os.Args[1:]) 35 | } 36 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2020 The Cmder Project Developers (given via the Git commit history). 2 | 3 | Permission is hereby granted, free of charge, to any 4 | person obtaining a copy of this software and associated 5 | documentation files (the "Software"), to deal in the 6 | Software without restriction, including without 7 | limitation the rights to use, copy, modify, merge, 8 | publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software 10 | is furnished to do so, subject to the following 11 | conditions: 12 | 13 | The above copyright notice and this permission notice 14 | shall be included in all copies or substantial portions 15 | of the Software. 16 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 18 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 19 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 20 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 21 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 22 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 23 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 24 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 25 | DEALINGS IN THE SOFTWARE. 26 | -------------------------------------------------------------------------------- /example/kurl/get.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | 7 | "github.com/hexops/cmder" 8 | ) 9 | 10 | func init() { 11 | const usage = ` 12 | Examples: 13 | 14 | Perform an HTTPS GET request on a URL: 15 | 16 | $ kurl get https://google.com 17 | 18 | Include verbose output: 19 | 20 | $ kurl get --verbose https://google.com 21 | ` 22 | 23 | // Parse flags for our subcommand. 24 | flagSet := flag.NewFlagSet("get", flag.ExitOnError) 25 | verboseFlag := flagSet.Bool("verbose", true, "include verbose information") 26 | 27 | // Handles calls to our subcommand. 28 | handler := func(args []string) error { 29 | _ = flagSet.Parse(args) 30 | 31 | // do something with args and *verboseFlag 32 | fmt.Println("subcommand called with", flagSet.Args(), "verbose?", *verboseFlag) 33 | 34 | // return &cmder.UsageError{} if usage text should be printed. 35 | 36 | // return &cmder.ExitCodeError{ExitStatus: ...} if a specific exit 37 | // code should be returned. 38 | 39 | // return any Go error if the command failed. 40 | return nil 41 | } 42 | 43 | // Register the command. 44 | commands = append(commands, &cmder.Command{ 45 | FlagSet: flagSet, 46 | Aliases: []string{"fetch"}, 47 | Handler: handler, 48 | UsageFunc: func() { 49 | fmt.Fprintf(flag.CommandLine.Output(), "Usage of 'kurl %s':\n", flagSet.Name()) 50 | flagSet.PrintDefaults() 51 | fmt.Fprintf(flag.CommandLine.Output(), "%s\n", usage) 52 | }, 53 | }) 54 | } 55 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cmder - lightweight Go pattern for writing CLIs Hexops logo 2 | 3 | Go Reference 4 | 5 | [![Go CI](https://github.com/hexops/cmder/workflows/Go%20CI/badge.svg)](https://github.com/hexops/cmder/actions) [![Go Report Card](https://goreportcard.com/badge/github.com/hexops/cmder)](https://goreportcard.com/report/github.com/hexops/cmder) 6 | 7 | Cmder is a ~100 LOC pattern that has been used as the foundation of all the Go CLIs [I've](https://twitter.com/slimsag) written (including [the Sourcegraph CLI](https://github.com/sourcegraph/src-cli/blob/1af97e4f78819ffd042ef000d964090dbb65268f/cmd/src/cmd.go#L1-L123).) 8 | 9 | I've [often just suggested others simply copy the pattern](https://twitter.com/slimsag/status/1330924665544404994) as it is so lightweight. Now you can import it as a Go package, which helps to document the pattern you're using, and avoids temptation to make it more complex than needed. 10 | 11 | * Mimics what the official `go` tool does internally. 12 | * Merely builds upon the `flag` package to support subcommands. 13 | * Supports subcommand flags, subcommands of subcommands, etc. 14 | 15 | ## Example 16 | 17 | An example/fictional HTTP tool called `kurl` is provided in the `example/kurl` directory. 18 | 19 | ## Usage 20 | 21 | The idea is simple, import the package: 22 | 23 | ```Go 24 | import "github.com/hexops/cmder" 25 | ``` 26 | 27 | Declare a list of your subcommands: 28 | 29 | ```Go 30 | // commands contains all registered subcommands. 31 | var commands cmder.Commander 32 | ``` 33 | 34 | Append a few subcommands like so (usually one `init` function per subcommand): 35 | 36 | ```Go 37 | flagSet := flag.NewFlagSet("foo", flag.ExitOnError) 38 | commands = append(commands, &cmder.Command{ 39 | FlagSet: flagSet, 40 | Handler: func(args []string) error { 41 | _ = flagSet.Parse(args) 42 | return nil 43 | }, 44 | }) 45 | ``` 46 | 47 | In your `main` function, call: 48 | 49 | ```Go 50 | commands.Run(flag.CommandLine, commandName, usageText, os.Args[1:]) 51 | ``` 52 | 53 | * Consult `go help` for inspiration on how to write your `usageText`. 54 | * Register subcommand flags by using e.g. `flagSet.Bool` (as you would've if using the Go `flag` package otherwise.) 55 | * Need subcommands in your subcommands? Declare another set of `commands` and simply call the `Run` method inside your subcommand `Handler`. 56 | 57 | Consult the [API documentation](https://pkg.go.dev/github.com/hexops/cmder) for more information. 58 | 59 | ## Project status 60 | 61 | We're open to considering improvements, but since this pattern has been in use in various CLIs over the past 3-4 years, we likely won't make any major changes to the API or introduce new features. The aim is to keep it minimal and simple. 62 | 63 | ## Popular alternatives 64 | 65 | Some popular alternatives which aim to be simple: 66 | 67 | - [peterbourgon/ff/ffcli](https://github.com/peterbourgon/ff/tree/master/ffcli) (quite good; also has config file parsing) 68 | - [google/subcommands](https://github.com/google/subcommands) (not quite as minimal as cmder) 69 | 70 | Some popular alternatives which provide as many features and knobs as you could want include: 71 | 72 | - [spf13/cobra](https://github.com/spf13/cobra) 73 | - [jessevdk/go-flags](https://github.com/jessevdk/go-flags) 74 | - [alecthomas/kingpin](https://github.com/alecthomas/kingpin) 75 | - [alecthomas/kong](https://github.com/alecthomas/kong) 76 | 77 | ## Version history 78 | 79 | ### v1.0.2 80 | 81 | Fixed an issue where subcommands incorrectly had their flags parsed twice. Handlers should always call `flagSet.Parse(args)` on the arguments passed to them, as demonstrated in `example/kurl/get.go`. 82 | 83 | ### v1.0.1 84 | 85 | Initial release. -------------------------------------------------------------------------------- /cmder.go: -------------------------------------------------------------------------------- 1 | package cmder 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | "log" 7 | "os" 8 | ) 9 | 10 | // Command is a subcommand handler and its associated flag set. 11 | type Command struct { 12 | // FlagSet is the flag set for the command. 13 | FlagSet *flag.FlagSet 14 | 15 | // Aliases for the command name. 16 | Aliases []string 17 | 18 | // Handler is the function that is invoked to handle this command. 19 | // 20 | // The error types *UsageError and *ExitCodeError have special meaning, consult their docs for 21 | // details. 22 | Handler func(args []string) error 23 | 24 | // A flagSet.Usage function to invoke when e.g. the -h flag is specified. If nil, a default one 25 | // is used. 26 | UsageFunc func() 27 | } 28 | 29 | // matches tells if the given name matches this command or one of its aliases. 30 | func (c *Command) matches(name string) bool { 31 | if name == c.FlagSet.Name() { 32 | return true 33 | } 34 | for _, alias := range c.Aliases { 35 | if name == alias { 36 | return true 37 | } 38 | } 39 | return false 40 | } 41 | 42 | // Commander represents a command with a list of subcommands. 43 | type Commander []*Command 44 | 45 | // Run runs a subcommand of the command described by the input flagSet (e.g. flag.CommandLine). 46 | // 47 | // cmdName and usageText should describe your command, not the subcommand. Consult "go help" for 48 | // inspiration when writing your own usageText. 49 | // 50 | // A special "help" command is registered automatically, which acts the same as the `-h` flag. 51 | func (c Commander) Run(flagSet *flag.FlagSet, cmdName, usageText string, args []string) { 52 | // Parse flags. 53 | flagSet.Usage = func() { 54 | fmt.Fprint(flag.CommandLine.Output(), usageText) 55 | } 56 | if !flagSet.Parsed() { 57 | // We assume flag.ExitOnError is in use. 58 | if err := flagSet.Parse(args); err != nil { 59 | panic(fmt.Sprintf("command should use flag.ExitOnError: error: %s", err)) 60 | } 61 | } 62 | 63 | // Print usage if the command is "help". 64 | if flagSet.Arg(0) == "help" || flagSet.NArg() == 0 { 65 | flagSet.Usage() 66 | os.Exit(0) 67 | } 68 | 69 | // Configure default usage funcs for commands. 70 | for _, cmd := range c { 71 | cmd := cmd 72 | if cmd.UsageFunc != nil { 73 | cmd.FlagSet.Usage = cmd.UsageFunc 74 | continue 75 | } 76 | cmd.FlagSet.Usage = func() { 77 | fmt.Fprintf(flag.CommandLine.Output(), "Usage of '%s %s':\n", cmdName, cmd.FlagSet.Name()) 78 | cmd.FlagSet.PrintDefaults() 79 | } 80 | } 81 | 82 | // Find the subcommand to execute. 83 | name := flagSet.Arg(0) 84 | for _, cmd := range c { 85 | if !cmd.matches(name) { 86 | continue 87 | } 88 | 89 | // Execute the subcommand. 90 | if err := cmd.Handler(flagSet.Args()[1:]); err != nil { 91 | if _, ok := err.(*UsageError); ok { 92 | log.Println(err) 93 | cmd.FlagSet.Usage() 94 | os.Exit(2) 95 | } 96 | if e, ok := err.(*ExitCodeError); ok { 97 | if e.Err != nil { 98 | log.Println(e) 99 | } 100 | os.Exit(e.ExitCode) 101 | } 102 | log.Fatal(err) 103 | } 104 | os.Exit(0) 105 | } 106 | log.Printf("%s: unknown subcommand %q", cmdName, name) 107 | log.Fatalf("Run '%s help' for usage.", cmdName) 108 | } 109 | 110 | // UsageError is an error type that subcommands can return in order to signal 111 | // that a usage error has occurred. 112 | type UsageError struct { 113 | // Err is the error to log when exiting. 114 | Err error 115 | } 116 | 117 | // Error implements the error interface. 118 | func (e *UsageError) Error() string { return e.Err.Error() } 119 | 120 | // ExitCodeError is an error type that subcommands can return in order to 121 | // specify the exact exit code. 122 | type ExitCodeError struct { 123 | // Err is the error to log when exiting. 124 | Err error 125 | 126 | // ExitCode is the exit status code to use in the call to os.Exit. 127 | ExitCode int 128 | } 129 | 130 | // Error implements the error interface. 131 | func (e *ExitCodeError) Error() string { return e.Err.Error() } 132 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------