fauna-shell/oclif.manifest.json

{"version":"0.11.4","commands":{"add-endpoint":{"id":"add-endpoint","description":"\nAdds a connection endpoint for FaunaDB\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna add-endpoint https://db.fauna.com:443","$ fauna add-endpoint http://localhost:8443/ --alias localhost --key secret"],"flags":{"alias":{"name":"alias","type":"option","description":"FaunaDB server endpoint alias","required":false},"key":{"name":"key","type":"option","description":"FaunaDB server endpoint key","required":false}},"args":[{"name":"endpoint","description":"FaunaDB server endpoint","required":true}]},"cloud-login":{"id":"cloud-login","description":"\nAdds the FaunaDB Cloud endpoint\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna cloud-login"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"}},"args":[]},"create-database":{"id":"create-database","description":"\nCreates a database\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna create-database dbname"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"}},"args":[{"name":"dbname","description":"database name","required":true}]},"create-key":{"id":"create-key","description":"\nCreates a key for the specified database\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna create-key dbname admin"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"}},"args":[{"name":"dbname","description":"database name","required":true},{"name":"role","description":"key user role","options":["admin","server","server-readonly","client"]}]},"default-endpoint":{"id":"default-endpoint","description":"\nSets an endpoint as the default one\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna default-endpoint endpoint"],"flags":{},"args":[{"name":"endpoint_alias","description":"FaunaDB server endpoint alias","required":true}]},"delete-database":{"id":"delete-database","description":"\nDeletes a database\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna delete-database dbname"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"}},"args":[{"name":"dbname","description":"database name","required":true}]},"delete-endpoint":{"id":"delete-endpoint","description":"\nDeletes a connection endpoint for FaunaDB\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna delete-endpoint endpoint_alias"],"flags":{},"args":[{"name":"endpoint_alias","description":"FaunaDB server endpoint alias","required":true}]},"delete-key":{"id":"delete-key","description":"\nDeletes a key\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna delete-key 123456789012345678"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"}},"args":[{"name":"keyname","description":"key name","required":true}]},"eval":{"id":"eval","description":"\nRuns the specified query. Can read from stdin, file or command line. \nOutputs to either stdout or file. \nOutput format can be specified.\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna eval \"Paginate(Classes())\"","$ fauna eval --file=/path/to/queries.fql","$ echo \"Add(1,1)\" | fauna eval --stdin","$ fauna eval \"Add(2,3)\" --output=/tmp/result\"","$ fauna eval \"Add(2,3)\" --format=json --output=/tmp/result\""],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"file":{"name":"file","type":"option","description":"File where to read queries from"},"stdin":{"name":"stdin","type":"boolean","description":"Read file input from stdin. Writes to stdout by default","allowNo":false},"output":{"name":"output","type":"option","description":"File to write output to","default":null},"format":{"name":"format","type":"option","description":"Output format","options":["json","shell"],"default":"json"}},"args":[{"name":"query","description":"FQL query to execute","required":false}]},"list-databases":{"id":"list-databases","description":"\nLists top level databases\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna list-databases"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"}},"args":[]},"list-endpoints":{"id":"list-endpoints","description":"\nLists FaunaDB connection endpoints\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna list-endpoints"],"flags":{},"args":[]},"list-keys":{"id":"list-keys","description":"\nLists top level keys\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna list-keys"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"}},"args":[]},"run-queries":{"id":"run-queries","description":"\nDeprecated: fauna run-queries is deprecated. Use eval instead\nRuns the queries found on the file passed to the command.\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna run-queries dbname --file=/path/to/queries.fql"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"file":{"name":"file","type":"option","description":"File where to read queries from","required":true}},"args":[{"name":"query","description":"FQL query to execute","required":false}]},"shell":{"id":"shell","description":"\nStarts a FaunaDB shell\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna shell dbname"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"}},"args":[{"name":"dbname","description":"database name","required":false}]}}}