{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"General commands","type":"basic","slug":"general-commands-1","excerpt":"","body":"##Overview\n\nUse the following general commands via the Seven Bridges Command Line Interface.\n\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##help\n\nUse this command to get help for the Seven Bridges Command Line Interface commands.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage: \\n  sb [command]\\n\\nAvailable Commands:\\n  apps         Manage apps on the CGC.\\n  billing      Obtain information about available billing groups.\\n  configure    Configure credentials to access your project on the CGC.\\n  exports      Manage exports on the CGC.\\n  files        Manage files on the CGC.\\n  upload       Upload your files to the CGC\\n  download     Download your files from the CGC.\\n  imports      Manage imports on the CGC.\\n  members      Manage project members on the CGC.\\n  projects     Manage projects on the CGC.\\n  tasks        Manage tasks on the CGC.\\n  version      Display the version of application currently used.\\n  volumes      Manage volumes on the CGC.\\n  whoami       Display information about the current user.\\n  troubleshoot Creates an archive file that can be sent to SevenBridges support.\\n\\nGlobal Flags:\\n      - -config string    Configuration file to use instead of the default one.\\n      - -debug            Run the command with debug information in the output.\\n      - -dryrun           Display output of a command without running it.\\n  -h, - -help             help for sb\\n      - -no-color         Turn on/off the color of the output.\\n      - -output string    The formatting style for command output (\\\"text\\\",\\n                         \\\"json\\\", \\\"table\\\"). (default \\\"text\\\")\\n      - -profile string   Configuration profile to use from credentials\\n                         file. (default \\\"default\\\")\\n      - -quiet            Suppress chatty console output.\",\n      \"language\": \"text\",\n      \"name\": \"help\"\n    }\n  ]\n}\n[/block]\n\n##troubleshoot\n\nUsing the `sb troubleshoot` command is an easy way to report a problem with the Seven Bridges Command Line Interface, with all relevant information included. This command generates a debug file on a specific location (on your local machine), so that you can send it to the Seven Bridges Support Team ([support:::at:::sbgenomics.com](mailto:[email protected])) along with the description of the problem. The location of the generated file is `$HOME/.sevenbridges/sb/report.tar.gz` and it will contain relevant information that should help Seven Bridges engineers identify the problem.\n\nUsage:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"sb troubleshoot [flags]\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nFlags:\n\n* `h`, `--help` - Help for the `troubleshoot` command\n\n##configure\n\nThis is a one-time operation that sets up user credentials for accessing a project on a specific environment. In order to access a project on the CGC, specify the environment and provide your corresponding authorization token.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb configure [flags]\\n\\nFlags:\\n  -h, - -help   help for configure\",\n      \"language\": \"text\",\n      \"name\": \"configure\"\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##whoami\n\nThis command returns information about the current user accessing the CGC.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb whoami [flags]\\n\\nFlags:\\n  -h, - -help   help for whoami\",\n      \"language\": \"text\",\n      \"name\": \"whoami\"\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##version\n\nThis command displays the version of the application currently used.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb version [flags]\\n\\nFlags:\\n  -h, - -help   help for version\",\n      \"language\": \"text\",\n      \"name\": \"version\"\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c2241c2f5dfdb004b065447","project":"55faf11ba62ba1170021a9a7","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":46},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"SB Command Line Interface","slug":"sb-cli","order":31,"from_sync":false,"reference":false,"_id":"5c22412594a2a5005cc9e919","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","createdAt":"2018-12-25T14:39:33.459Z","__v":0},"user":"566590c83889610d0008a253","createdAt":"2018-12-25T14:42:10.073Z","__v":0,"parentDoc":null}
##Overview Use the following general commands via the Seven Bridges Command Line Interface. <div align="right"><a href="#top">top</a></div> ##help Use this command to get help for the Seven Bridges Command Line Interface commands. [block:code] { "codes": [ { "code": "Usage: \n sb [command]\n\nAvailable Commands:\n apps Manage apps on the CGC.\n billing Obtain information about available billing groups.\n configure Configure credentials to access your project on the CGC.\n exports Manage exports on the CGC.\n files Manage files on the CGC.\n upload Upload your files to the CGC\n download Download your files from the CGC.\n imports Manage imports on the CGC.\n members Manage project members on the CGC.\n projects Manage projects on the CGC.\n tasks Manage tasks on the CGC.\n version Display the version of application currently used.\n volumes Manage volumes on the CGC.\n whoami Display information about the current user.\n troubleshoot Creates an archive file that can be sent to SevenBridges support.\n\nGlobal Flags:\n - -config string Configuration file to use instead of the default one.\n - -debug Run the command with debug information in the output.\n - -dryrun Display output of a command without running it.\n -h, - -help help for sb\n - -no-color Turn on/off the color of the output.\n - -output string The formatting style for command output (\"text\",\n \"json\", \"table\"). (default \"text\")\n - -profile string Configuration profile to use from credentials\n file. (default \"default\")\n - -quiet Suppress chatty console output.", "language": "text", "name": "help" } ] } [/block] ##troubleshoot Using the `sb troubleshoot` command is an easy way to report a problem with the Seven Bridges Command Line Interface, with all relevant information included. This command generates a debug file on a specific location (on your local machine), so that you can send it to the Seven Bridges Support Team ([[email protected]](mailto:[email protected])) along with the description of the problem. The location of the generated file is `$HOME/.sevenbridges/sb/report.tar.gz` and it will contain relevant information that should help Seven Bridges engineers identify the problem. Usage: [block:code] { "codes": [ { "code": "sb troubleshoot [flags]", "language": "shell" } ] } [/block] Flags: * `h`, `--help` - Help for the `troubleshoot` command ##configure This is a one-time operation that sets up user credentials for accessing a project on a specific environment. In order to access a project on the CGC, specify the environment and provide your corresponding authorization token. [block:code] { "codes": [ { "code": "Usage:\n sb configure [flags]\n\nFlags:\n -h, - -help help for configure", "language": "text", "name": "configure" } ] } [/block] <div align="right"><a href="#top">top</a></div> ##whoami This command returns information about the current user accessing the CGC. [block:code] { "codes": [ { "code": "Usage:\n sb whoami [flags]\n\nFlags:\n -h, - -help help for whoami", "language": "text", "name": "whoami" } ] } [/block] <div align="right"><a href="#top">top</a></div> ##version This command displays the version of the application currently used. [block:code] { "codes": [ { "code": "Usage:\n sb version [flags]\n\nFlags:\n -h, - -help help for version", "language": "text", "name": "version" } ] } [/block] <div align="right"><a href="#top">top</a></div>