{"_id":"5a2a8232878ac8001ce472c6","project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":40,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5a2a81f688574d001e9934f5","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-12-08T12:13:42.092Z","from_sync":false,"order":36,"slug":"sbfs-command-reference","title":"SBFS Command Reference"},"user":"566590c83889610d0008a253","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-08T12:14:42.204Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Use SBFS, a command line tool, to interact with CGC project files mounted as a local file system. The general syntax for the SBFS commands is:\n\n`sbfs [global-parameters] command [command-parameters]`\n\n##Global parameters\n\nGlobal parameters can be used anywhere within the command line. On the other hand, command-specific parameters can only be used after specifying the command.\n\nIf a global parameter is not applicable for a given command, it will be ignored. For an example, if you use an `- -api-endpoint` parameter with the version command or `- -profile` parameter with the unmount command the specified global parameter will be ignored.\n\nThe following global parameters are available:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`- -profile <profile-name>`\",\n    \"0-1\": \"The configuration profile from the [unified configuration file](doc:store-credentials-to-access-seven-bridges-client-applications-and-libraries#section-unified-configuration-file). If omitted, the default profile (\\\"default\\\") is used.\",\n    \"1-0\": \"`- -api-endpoint <url>`\",\n    \"1-1\": \"Use this parameter to explicitly provide the API endpoint for CGC: https://cgc-api.sbgenomics.com/v2.\\n\\nThis parameter must be used in combination with explicitly passing your authentication token as mentioned below.\\n\\nIf this parameter is provided explicitly through the command line, it overrides stored parameters within the [unified configuration file](doc:store-credentials-to-access-seven-bridges-client-applications-and-libraries#section-unified-configuration-file) or environment variables.\",\n    \"2-0\": \"`- -auth-token <token>`\",\n    \"2-1\": \"Use this parameter to pass your [authentication token](doc:get-your-authentication-token) explicitly. This parameter must be used in combination with explicitly passing the API endpoint, as mentioned above.\\nIf these parameters are provided through the command line, they will override the parameters specified in the credentials file or as environment variables.\",\n    \"3-0\": \"`debug`\",\n    \"3-1\": \"This parameter Includes debug information in the output (verbose output).\",\n    \"4-0\": \"`- -help`\",\n    \"4-1\": \"Use this parameter to display help for a specific command.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n##Commands\n\nThe following commands are available. Learn more about each command from the resources below the table.\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Command\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`configure`\",\n    \"0-1\": \"Configure credentials for accessing a project on CGC.\",\n    \"1-0\": \"`list`\",\n    \"1-1\": \"List projects which are available for mounting.\",\n    \"2-0\": \"`mount`\",\n    \"2-1\": \"Mount files from the specified Seven Bridges project as a local file system.\",\n    \"3-0\": \"`unmount`\",\n    \"3-1\": \"Unmount a file system previously mounted via SBFS.\",\n    \"4-0\": \"`version`\",\n    \"4-1\": \"Display the currently used version of the application.\",\n    \"5-0\": \"`help\",\n    \"5-1\": \"Display help on a specific command or display general help if the command is omitted.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n##Resources\n\n  * [Configure](doc:configure)\n  * [List](doc:list)\n  * [Mount](doc:mount)\n  * [Unmount](doc:unmount)\n  * [General commands](doc:general-commands)","excerpt":"","slug":"command-reference-overview","type":"basic","title":"Overview"}
Use SBFS, a command line tool, to interact with CGC project files mounted as a local file system. The general syntax for the SBFS commands is: `sbfs [global-parameters] command [command-parameters]` ##Global parameters Global parameters can be used anywhere within the command line. On the other hand, command-specific parameters can only be used after specifying the command. If a global parameter is not applicable for a given command, it will be ignored. For an example, if you use an `- -api-endpoint` parameter with the version command or `- -profile` parameter with the unmount command the specified global parameter will be ignored. The following global parameters are available: [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "`- -profile <profile-name>`", "0-1": "The configuration profile from the [unified configuration file](doc:store-credentials-to-access-seven-bridges-client-applications-and-libraries#section-unified-configuration-file). If omitted, the default profile (\"default\") is used.", "1-0": "`- -api-endpoint <url>`", "1-1": "Use this parameter to explicitly provide the API endpoint for CGC: https://cgc-api.sbgenomics.com/v2.\n\nThis parameter must be used in combination with explicitly passing your authentication token as mentioned below.\n\nIf this parameter is provided explicitly through the command line, it overrides stored parameters within the [unified configuration file](doc:store-credentials-to-access-seven-bridges-client-applications-and-libraries#section-unified-configuration-file) or environment variables.", "2-0": "`- -auth-token <token>`", "2-1": "Use this parameter to pass your [authentication token](doc:get-your-authentication-token) explicitly. This parameter must be used in combination with explicitly passing the API endpoint, as mentioned above.\nIf these parameters are provided through the command line, they will override the parameters specified in the credentials file or as environment variables.", "3-0": "`debug`", "3-1": "This parameter Includes debug information in the output (verbose output).", "4-0": "`- -help`", "4-1": "Use this parameter to display help for a specific command." }, "cols": 2, "rows": 5 } [/block] ##Commands The following commands are available. Learn more about each command from the resources below the table. [block:parameters] { "data": { "h-0": "Command", "h-1": "Description", "0-0": "`configure`", "0-1": "Configure credentials for accessing a project on CGC.", "1-0": "`list`", "1-1": "List projects which are available for mounting.", "2-0": "`mount`", "2-1": "Mount files from the specified Seven Bridges project as a local file system.", "3-0": "`unmount`", "3-1": "Unmount a file system previously mounted via SBFS.", "4-0": "`version`", "4-1": "Display the currently used version of the application.", "5-0": "`help", "5-1": "Display help on a specific command or display general help if the command is omitted." }, "cols": 2, "rows": 6 } [/block] ##Resources * [Configure](doc:configure) * [List](doc:list) * [Mount](doc:mount) * [Unmount](doc:unmount) * [General commands](doc:general-commands)