github.com/willyham/dosa@v2.3.1-0.20171024181418-1e446d37ee71+incompatible/cmd/dosa/doc.go (about) 1 // Copyright (c) 2017 Uber Technologies, Inc. 2 // 3 // Permission is hereby granted, free of charge, to any person obtaining a copy 4 // of this software and associated documentation files (the "Software"), to deal 5 // in the Software without restriction, including without limitation the rights 6 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 // copies of the Software, and to permit persons to whom the Software is 8 // furnished to do so, subject to the following conditions: 9 // 10 // The above copyright notice and this permission notice shall be included in 11 // all copies or substantial portions of the Software. 12 // 13 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 19 // THE SOFTWARE. 20 21 /* 22 Package main is the entrypoint for the dosa CLI. Some examples below: 23 24 25 Options for all commands: 26 27 Override default host:port for gateway: 28 29 $ dosa -h 192.168.0.2 -p 8080 <cmd> 30 31 Provide a custom service name, "foo" for gateway (when using TChannel): 32 33 $ dosa --service dosa-foo <cmd> ... 34 35 Use "dosacli-infra" as caller name for RPCs to gateway: 36 37 $ dosa --caller dosacli-infra <cmd> 38 39 Provide a custom timeout of 20 seconds for RPCs to gateway: 40 41 $ dosa --timeout 20s <cmd> 42 43 44 Managing Scopes: 45 46 Create a new scope called "infra_dev": 47 48 $ dosa scope create infra_dev 49 50 List all scopes created by $USER (you): 51 52 $ dosa scope list 53 54 Scope subcommand usage: 55 56 $ dosa scope help 57 58 59 Managing Schema: 60 61 Dump schema to stdout as CQL (default is Avro): 62 63 $ dosa schema dump -as cql 64 65 Check the compatibility status of all schema in the "infra_dev" scope: 66 67 $ dosa schema status -s infra_dev 68 69 Check the compatibility status of the schema with prefix "oss.user" in the "infra_dev" scope: 70 71 $ dosa schema status -s infra_dev -np oss.user 72 73 Upsert schema with prefix "oss.user" to the "infra_dev" scope: 74 75 $ dosa schema upsert -s infra_dev -np oss.user 76 77 78 Code Generation: 79 80 TODO 81 82 $ dosa gen ... 83 84 85 Defining Custom Commands: 86 87 TODO 88 89 $ dosa mycmd ... 90 91 */ 92 package main