opencode-skills-collection 3.1.12 → 3.1.14

package/bundled-skills/rclone-cli/references/providers/fichier.md

@@ -0,0 +1,230 @@
+---
+title: "1Fichier"
+description: "Rclone docs for 1Fichier"
+versionIntroduced: "v1.49"
+---
+
+> **Official documentation:** [https://rclone.org/fichier/](https://rclone.org/fichier/)
+# 1Fichier
+
+This is a backend for the [1fichier](https://1fichier.com) cloud
+storage service. Note that a Premium subscription is required to use
+the API.
+
+Paths are specified as `remote:path`
+
+Paths may be as deep as required, e.g. `remote:directory/subdirectory`.
+
+## Configuration
+
+The initial setup for 1Fichier involves getting the API key from the website
+which you need to do in your browser.
+
+Here is an example of how to make a remote called `remote`.  First run:
+
+```console
+rclone config
+```
+
+This will guide you through an interactive setup process:
+
+```text
+No remotes found, make a new one?
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+[snip]
+XX / 1Fichier
+   \ "fichier"
+[snip]
+Storage> fichier
+** See help for fichier backend at: https://rclone.org/fichier/ **
+
+Your API Key, get it from https://1fichier.com/console/params.pl
+Enter a string value. Press Enter for the default ("").
+api_key> example_key
+
+Edit advanced config? (y/n)
+y) Yes
+n) No
+y/n>
+Remote config
+Configuration complete.
+Options:
+- type: fichier
+- api_key: example_key
+Keep this "remote" remote?
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+```
+
+Once configured you can then use `rclone` like this (replace `remote` with the
+name you gave your remote):
+
+
+List directories in top level of your 1Fichier account
+
+```console
+rclone lsd remote:
+```
+
+List all the files in your 1Fichier account
+
+```console
+rclone ls remote:
+```
+
+To copy a local directory to a 1Fichier directory called backup
+
+```console
+rclone copy /home/source remote:backup
+```
+
+### Modification times and hashes
+
+1Fichier does not support modification times. It supports the Whirlpool hash algorithm.
+
+### Duplicated files
+
+1Fichier can have two files with exactly the same name and path (unlike a
+normal file system).
+
+Duplicated files cause problems with the syncing and you will see
+messages in the log about duplicates.
+
+### Restricted filename characters
+
+In addition to the [default restricted characters set](/overview/#restricted-characters)
+the following characters are also replaced:
+
+| Character | Value | Replacement |
+| --------- |:-----:|:-----------:|
+| \         | 0x5C  | ＼           |
+| <         | 0x3C  | ＜           |
+| >         | 0x3E  | ＞           |
+| "         | 0x22  | ＂           |
+| $         | 0x24  | ＄           |
+| `         | 0x60  | ｀           |
+| '         | 0x27  | ＇           |
+
+File names can also not start or end with the following characters.
+These only get replaced if they are the first or last character in the
+name:
+
+| Character | Value | Replacement |
+| --------- |:-----:|:-----------:|
+| SP        | 0x20  | ␠           |
+
+Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
+as they can't be used in JSON strings.
+
+<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/fichier/fichier.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
+### Standard options
+
+Here are the Standard options specific to fichier (1Fichier).
+
+#### --fichier-api-key
+
+Your API Key, get it from https://1fichier.com/console/params.pl.
+
+Properties:
+
+- Config:      api_key
+- Env Var:     RCLONE_FICHIER_API_KEY
+- Type:        string
+- Required:    false
+
+### Advanced options
+
+Here are the Advanced options specific to fichier (1Fichier).
+
+#### --fichier-shared-folder
+
+If you want to download a shared folder, add this parameter.
+
+Properties:
+
+- Config:      shared_folder
+- Env Var:     RCLONE_FICHIER_SHARED_FOLDER
+- Type:        string
+- Required:    false
+
+#### --fichier-file-password
+
+If you want to download a shared file that is password protected, add this parameter.
+
+**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
+
+Properties:
+
+- Config:      file_password
+- Env Var:     RCLONE_FICHIER_FILE_PASSWORD
+- Type:        string
+- Required:    false
+
+#### --fichier-folder-password
+
+If you want to list the files in a shared folder that is password protected, add this parameter.
+
+**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
+
+Properties:
+
+- Config:      folder_password
+- Env Var:     RCLONE_FICHIER_FOLDER_PASSWORD
+- Type:        string
+- Required:    false
+
+#### --fichier-cdn
+
+Set if you wish to use CDN download links.
+
+Properties:
+
+- Config:      cdn
+- Env Var:     RCLONE_FICHIER_CDN
+- Type:        bool
+- Default:     false
+
+#### --fichier-encoding
+
+The encoding for the backend.
+
+See the [encoding section in the overview](/overview/#encoding) for more info.
+
+Properties:
+
+- Config:      encoding
+- Env Var:     RCLONE_FICHIER_ENCODING
+- Type:        Encoding
+- Default:     Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
+
+#### --fichier-description
+
+Description of the remote.
+
+Properties:
+
+- Config:      description
+- Env Var:     RCLONE_FICHIER_DESCRIPTION
+- Type:        string
+- Required:    false
+
+<!-- autogenerated options stop -->
+
+## Limitations
+
+`rclone about` is not supported by the 1Fichier backend. Backends without
+this capability cannot determine free space for an rclone mount or
+use policy `mfs` (most free space) as a member of an rclone union
+remote.
+
+See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
+and [rclone about](https://rclone.org/commands/rclone_about/).

package/bundled-skills/rclone-cli/references/providers/filefabric.md

@@ -0,0 +1,298 @@
+---
+title: "Enterprise File Fabric"
+description: "Rclone docs for the Enterprise File Fabric backend"
+versionIntroduced: "v1.54"
+---
+
+> **Official documentation:** [https://rclone.org/filefabric/](https://rclone.org/filefabric/)
+# Enterprise File Fabric
+
+This backend supports [Storage Made Easy's Enterprise File
+Fabric™](https://storagemadeeasy.com/about/) which provides a software
+solution to integrate and unify File and Object Storage accessible
+through a global file system.
+
+## Configuration
+
+The initial setup for the Enterprise File Fabric backend involves
+getting a token from the Enterprise File Fabric which you need to
+do in your browser.  `rclone config` walks you through it.
+
+Here is an example of how to make a remote called `remote`.  First run:
+
+```console
+rclone config
+```
+
+This will guide you through an interactive setup process:
+
+```text
+No remotes found, make a new one?
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+[snip]
+XX / Enterprise File Fabric
+   \ "filefabric"
+[snip]
+Storage> filefabric
+** See help for filefabric backend at: https://rclone.org/filefabric/ **
+
+URL of the Enterprise File Fabric to connect to
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / Storage Made Easy US
+   \ "https://storagemadeeasy.com"
+ 2 / Storage Made Easy EU
+   \ "https://eu.storagemadeeasy.com"
+ 3 / Connect to your Enterprise File Fabric
+   \ "https://yourfabric.smestorage.com"
+url> https://yourfabric.smestorage.com/
+ID of the root folder
+Leave blank normally.
+
+Fill in to make rclone start with directory of a given ID.
+
+Enter a string value. Press Enter for the default ("").
+root_folder_id>
+Permanent Authentication Token
+
+A Permanent Authentication Token can be created in the Enterprise File
+Fabric, on the users Dashboard under Security, there is an entry
+you'll see called "My Authentication Tokens". Click the Manage button
+to create one.
+
+These tokens are normally valid for several years.
+
+For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens
+
+Enter a string value. Press Enter for the default ("").
+permanent_token> xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx
+Edit advanced config? (y/n)
+y) Yes
+n) No (default)
+y/n> n
+Remote config
+Configuration complete.
+Options:
+- type: filefabric
+- url: https://yourfabric.smestorage.com/
+- permanent_token: xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx
+Keep this "remote" remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+```
+
+Once configured you can then use `rclone` like this (replace `remote` with the
+name you gave your remote):
+
+List directories in top level of your Enterprise File Fabric
+
+```console
+rclone lsd remote:
+```
+
+List all the files in your Enterprise File Fabric
+
+```console
+rclone ls remote:
+```
+
+To copy a local directory to an Enterprise File Fabric directory called backup
+
+```console
+rclone copy /home/source remote:backup
+```
+
+### Modification times and hashes
+
+The Enterprise File Fabric allows modification times to be set on
+files accurate to 1 second.  These will be used to detect whether
+objects need syncing or not.
+
+The Enterprise File Fabric does not support any data hashes at this time.
+
+### Restricted filename characters
+
+The [default restricted characters set](/overview/#restricted-characters)
+will be replaced.
+
+Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
+as they can't be used in JSON strings.
+
+### Empty files
+
+Empty files aren't supported by the Enterprise File Fabric. Rclone will therefore
+upload an empty file as a single space with a mime type of
+`application/vnd.rclone.empty.file` and files with that mime type are
+treated as empty.
+
+### Root folder ID
+
+You can set the `root_folder_id` for rclone.  This is the directory
+(identified by its `Folder ID`) that rclone considers to be the root
+of your Enterprise File Fabric.
+
+Normally you will leave this blank and rclone will determine the
+correct root to use itself.
+
+However you can set this to restrict rclone to a specific folder
+hierarchy.
+
+In order to do this you will have to find the `Folder ID` of the
+directory you wish rclone to display.  These aren't displayed in the
+web interface, but you can use `rclone lsf` to find them, for example
+
+```console
+$ rclone lsf --dirs-only -Fip --csv filefabric:
+120673758,Burnt PDFs/
+120673759,My Quick Uploads/
+120673755,My Syncs/
+120673756,My backups/
+120673757,My contacts/
+120673761,S3 Storage/
+```
+
+The ID for "S3 Storage" would be `120673761`.
+
+<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/filefabric/filefabric.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
+### Standard options
+
+Here are the Standard options specific to filefabric (Enterprise File Fabric).
+
+#### --filefabric-url
+
+URL of the Enterprise File Fabric to connect to.
+
+Properties:
+
+- Config:      url
+- Env Var:     RCLONE_FILEFABRIC_URL
+- Type:        string
+- Required:    true
+- Examples:
+  - "https://storagemadeeasy.com"
+    - Storage Made Easy US
+  - "https://eu.storagemadeeasy.com"
+    - Storage Made Easy EU
+  - "https://yourfabric.smestorage.com"
+    - Connect to your Enterprise File Fabric
+
+#### --filefabric-root-folder-id
+
+ID of the root folder.
+
+Leave blank normally.
+
+Fill in to make rclone start with directory of a given ID.
+
+
+Properties:
+
+- Config:      root_folder_id
+- Env Var:     RCLONE_FILEFABRIC_ROOT_FOLDER_ID
+- Type:        string
+- Required:    false
+
+#### --filefabric-permanent-token
+
+Permanent Authentication Token.
+
+A Permanent Authentication Token can be created in the Enterprise File
+Fabric, on the users Dashboard under Security, there is an entry
+you'll see called "My Authentication Tokens". Click the Manage button
+to create one.
+
+These tokens are normally valid for several years.
+
+For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens
+
+
+Properties:
+
+- Config:      permanent_token
+- Env Var:     RCLONE_FILEFABRIC_PERMANENT_TOKEN
+- Type:        string
+- Required:    false
+
+### Advanced options
+
+Here are the Advanced options specific to filefabric (Enterprise File Fabric).
+
+#### --filefabric-token
+
+Session Token.
+
+This is a session token which rclone caches in the config file. It is
+usually valid for 1 hour.
+
+Don't set this value - rclone will set it automatically.
+
+
+Properties:
+
+- Config:      token
+- Env Var:     RCLONE_FILEFABRIC_TOKEN
+- Type:        string
+- Required:    false
+
+#### --filefabric-token-expiry
+
+Token expiry time.
+
+Don't set this value - rclone will set it automatically.
+
+
+Properties:
+
+- Config:      token_expiry
+- Env Var:     RCLONE_FILEFABRIC_TOKEN_EXPIRY
+- Type:        string
+- Required:    false
+
+#### --filefabric-version
+
+Version read from the file fabric.
+
+Don't set this value - rclone will set it automatically.
+
+
+Properties:
+
+- Config:      version
+- Env Var:     RCLONE_FILEFABRIC_VERSION
+- Type:        string
+- Required:    false
+
+#### --filefabric-encoding
+
+The encoding for the backend.
+
+See the [encoding section in the overview](/overview/#encoding) for more info.
+
+Properties:
+
+- Config:      encoding
+- Env Var:     RCLONE_FILEFABRIC_ENCODING
+- Type:        Encoding
+- Default:     Slash,Del,Ctl,InvalidUtf8,Dot
+
+#### --filefabric-description
+
+Description of the remote.
+
+Properties:
+
+- Config:      description
+- Env Var:     RCLONE_FILEFABRIC_DESCRIPTION
+- Type:        string
+- Required:    false
+
+<!-- autogenerated options stop -->