{"_id":"59a556ae92c7f300191cb9c3","project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":38,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"59a555bccdbd85001bfb1442","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-08-29T11:53:32.348Z","from_sync":false,"order":9999,"slug":"sbfs-beta","title":"SBFS (Beta)"},"user":"566590c83889610d0008a253","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-29T11:57:34.073Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"##Overview\n\nWhen you mount a project, all files from that project become available as a local file system. You can mount one, several, or all of your projects.\n\nOnce you mount a project, its files will become available in the local folder that you specified. There, you can manage them via the command line interface as you would any other file on your computer, such as opening the files in an application, or adding and removing files from that folder.\n\nThe recommended method for managing the files is via the command line interface. Furthermore, it is recommended that you disable file previews for the applications used to open files, as previews can cause significant increase in the data traffic between the CGC and your computer.\n\n##Prerequisites\n\nBefore mounting a project, you need to create a dedicated empty folder on your computer which will be used for placing the project files.\n\n##Mount a single project\n\nTo mount your project, issue the following command:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"sbfs mount <dir> --project <username/project-name>\",\n      \"language\": \"text\",\n      \"name\": \"Mounting a project\"\n    }\n  ]\n}\n[/block]\nFor example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"sbfs mount ~/documents/my-folder --project rfranklin/my-project\",\n      \"language\": \"text\",\n      \"name\": \"Example command for mounting a project\"\n    }\n  ]\n}\n[/block]\nThe first parameter is used to specify the address of your local folder (either absolute or relative), followed by the --project option to specify the name of the project you want to mount.\n\n##Mount multiple projects\n\nTo mount all projects you have access to, omit the `--project option`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"sbfs mount ~/documents/my-folder\",\n      \"language\": \"text\",\n      \"name\": \"Mounting multiple projects\"\n    }\n  ]\n}\n[/block]\n##Optional parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Option\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`--project <project-name>`\",\n    \"0-1\": \"The option for specifying the name of the project which will be mounted. If you are mounting more than one project, the project names must be separated with a comma (,). To mount all available projects, omit this option.\",\n    \"1-0\": \"`--foreground`\",\n    \"1-1\": \"The option for making the SBFS stay in the foreground after mounting. All output messages will be sent to standard output stream (stdout) or to the log file if command is executed with the `--log-file` option.\",\n    \"2-0\": \"`--dir-mode <value>`\",\n    \"2-1\": \"The option for specifying access permissions for the directories. The default value is: 755.\",\n    \"3-0\": \"`-file-mode <value`\",\n    \"3-1\": \"The option for specifying access permissions for the files. The default value is: 644.\",\n    \"4-0\": \"`--read-only`\",\n    \"4-1\": \"Mount the file system in read-only mode. By default, file system is mounted in write mode. Using this option implies that all files written to the mountpoint will be removed on unmount, without any changes to the project on the CGC platform. It is also not possible to remove files or directories.\",\n    \"5-0\": \"`--allow-other`\",\n    \"5-1\": \"Use this option to allow other OS users to access the mounted file system. By default, only the current user (that executed the mount command) will be able to access the file system.\",\n    \"6-0\": \"`--disk-cache-size`\",\n    \"6-1\": \"Size of SBFS cache on the local disk. Default size is 4 GiB.\",\n    \"7-0\": \"`--disk-cache-path`\",\n    \"7-1\": \"Path of SBFS cache on the local disk. Default path is `$TMPDIR`.\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n##Resources\n\n* [Unmount a project](doc:unmount-a-project)\n* [List available projects for SBFS](doc:list-available-projects-for-sbfs)","excerpt":"","slug":"mount-a-project","type":"basic","title":"Mount a project"}
##Overview When you mount a project, all files from that project become available as a local file system. You can mount one, several, or all of your projects. Once you mount a project, its files will become available in the local folder that you specified. There, you can manage them via the command line interface as you would any other file on your computer, such as opening the files in an application, or adding and removing files from that folder. The recommended method for managing the files is via the command line interface. Furthermore, it is recommended that you disable file previews for the applications used to open files, as previews can cause significant increase in the data traffic between the CGC and your computer. ##Prerequisites Before mounting a project, you need to create a dedicated empty folder on your computer which will be used for placing the project files. ##Mount a single project To mount your project, issue the following command: [block:code] { "codes": [ { "code": "sbfs mount <dir> --project <username/project-name>", "language": "text", "name": "Mounting a project" } ] } [/block] For example: [block:code] { "codes": [ { "code": "sbfs mount ~/documents/my-folder --project rfranklin/my-project", "language": "text", "name": "Example command for mounting a project" } ] } [/block] The first parameter is used to specify the address of your local folder (either absolute or relative), followed by the --project option to specify the name of the project you want to mount. ##Mount multiple projects To mount all projects you have access to, omit the `--project option`. [block:code] { "codes": [ { "code": "sbfs mount ~/documents/my-folder", "language": "text", "name": "Mounting multiple projects" } ] } [/block] ##Optional parameters [block:parameters] { "data": { "h-0": "Option", "h-1": "Description", "0-0": "`--project <project-name>`", "0-1": "The option for specifying the name of the project which will be mounted. If you are mounting more than one project, the project names must be separated with a comma (,). To mount all available projects, omit this option.", "1-0": "`--foreground`", "1-1": "The option for making the SBFS stay in the foreground after mounting. All output messages will be sent to standard output stream (stdout) or to the log file if command is executed with the `--log-file` option.", "2-0": "`--dir-mode <value>`", "2-1": "The option for specifying access permissions for the directories. The default value is: 755.", "3-0": "`-file-mode <value`", "3-1": "The option for specifying access permissions for the files. The default value is: 644.", "4-0": "`--read-only`", "4-1": "Mount the file system in read-only mode. By default, file system is mounted in write mode. Using this option implies that all files written to the mountpoint will be removed on unmount, without any changes to the project on the CGC platform. It is also not possible to remove files or directories.", "5-0": "`--allow-other`", "5-1": "Use this option to allow other OS users to access the mounted file system. By default, only the current user (that executed the mount command) will be able to access the file system.", "6-0": "`--disk-cache-size`", "6-1": "Size of SBFS cache on the local disk. Default size is 4 GiB.", "7-0": "`--disk-cache-path`", "7-1": "Path of SBFS cache on the local disk. Default path is `$TMPDIR`." }, "cols": 2, "rows": 8 } [/block] ##Resources * [Unmount a project](doc:unmount-a-project) * [List available projects for SBFS](doc:list-available-projects-for-sbfs)