github-mirror/rclone
2
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-12-19 01:03:42 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
cf25ae69ad
rclone/fs/rc/rcflags/rcflags.go

38 lines
2.3 KiB
Go
Raw Normal View History

Implement Remote Control for rclone #2111 This implements a remote control protocol activated with the --rc flag and a new command `rclone rc` to use that interface. Still to do * docs - need finishing * tests
2018-03-05 19:44:16 +08:00
// Package rcflags implements command line flags to set up the remote control
package rcflags
import (
build: fix up package paths after repo move git grep -l github.com/ncw/rclone | xargs -d'\n' perl -i~ -lpe 's|github.com/ncw/rclone|github.com/rclone/rclone|g' goimports -w `find . -name \*.go`
2019-07-29 01:47:38 +08:00
"github.com/rclone/rclone/fs/config/flags"
"github.com/rclone/rclone/fs/rc"
Implement Remote Control for rclone #2111 This implements a remote control protocol activated with the --rc flag and a new command `rclone rc` to use that interface. Still to do * docs - need finishing * tests
2018-03-05 19:44:16 +08:00
"github.com/spf13/pflag"
)
rc: fix missing --rc flags In this commit we accidentally removed the global --rc flags. 0df7466d2b077138 cmd/rcd: Fix command docs to include command specific prefix (#6675) This re-instates them.
2023-03-23 20:04:17 +08:00
// FlagPrefix is the prefix used to uniquely identify command line flags.
const FlagPrefix = "rc-"
Implement Remote Control for rclone #2111 This implements a remote control protocol activated with the --rc flag and a new command `rclone rc` to use that interface. Still to do * docs - need finishing * tests
2018-03-05 19:44:16 +08:00
// Options set by command line flags
var (
Opt = rc.DefaultOpt
)
// AddFlags adds the remote control flags to the flagSet
rc: fix missing --rc flags In this commit we accidentally removed the global --rc flags. 0df7466d2b077138 cmd/rcd: Fix command docs to include command specific prefix (#6675) This re-instates them.
2023-03-23 20:04:17 +08:00
func AddFlags(flagSet *pflag.FlagSet) {
rc: implement options/blocks,get,set and register options
2018-10-28 06:58:18 +08:00
rc.AddOption("rc", &Opt)
docs: group the global flags and make them appear on command and flags pages This adds an additional parameter to the creation of each flag. This specifies one or more flag groups. This **must** be set for global flags and **must not** be set for local flags. This causes flags.md to be built with sections to aid comprehension and it causes the documentation pages for each command (and the `--help`) to be built showing the flags groups as specified in the `groups` annotation on the command. See: https://forum.rclone.org/t/make-docs-for-mortals-not-only-rclone-gurus/39476/
2023-07-11 01:34:10 +08:00
flags.BoolVarP(flagSet, &Opt.Enabled, "rc", "", false, "Enable the remote control server", "RC")
flags.StringVarP(flagSet, &Opt.Files, "rc-files", "", "", "Path to local files to serve on the HTTP server", "RC")
flags.BoolVarP(flagSet, &Opt.Serve, "rc-serve", "", false, "Enable the serving of remote objects", "RC")
rcserver: set `ModTime` for dirs and files served by `--rc-serve`
2023-09-26 02:03:38 +08:00
flags.BoolVarP(flagSet, &Opt.ServeNoModTime, "rc-serve-no-modtime", "", false, "Don't read the modification time (can speed things up)", "RC")
docs: group the global flags and make them appear on command and flags pages This adds an additional parameter to the creation of each flag. This specifies one or more flag groups. This **must** be set for global flags and **must not** be set for local flags. This causes flags.md to be built with sections to aid comprehension and it causes the documentation pages for each command (and the `--help`) to be built showing the flags groups as specified in the `groups` annotation on the command. See: https://forum.rclone.org/t/make-docs-for-mortals-not-only-rclone-gurus/39476/
2023-07-11 01:34:10 +08:00
flags.BoolVarP(flagSet, &Opt.NoAuth, "rc-no-auth", "", false, "Don't require auth for certain methods", "RC")
flags.BoolVarP(flagSet, &Opt.WebUI, "rc-web-gui", "", false, "Launch WebGUI on localhost", "RC")
flags.BoolVarP(flagSet, &Opt.WebGUIUpdate, "rc-web-gui-update", "", false, "Check and update to latest version of web gui", "RC")
flags.BoolVarP(flagSet, &Opt.WebGUIForceUpdate, "rc-web-gui-force-update", "", false, "Force update to latest version of web gui", "RC")
flags.BoolVarP(flagSet, &Opt.WebGUINoOpenBrowser, "rc-web-gui-no-open-browser", "", false, "Don't open the browser automatically", "RC")
flags.StringVarP(flagSet, &Opt.WebGUIFetchURL, "rc-web-fetch-url", "", "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest", "URL to fetch the releases for webgui", "RC")
flags.BoolVarP(flagSet, &Opt.EnableMetrics, "rc-enable-metrics", "", false, "Enable prometheus metrics on /metrics", "RC")
flags.DurationVarP(flagSet, &Opt.JobExpireDuration, "rc-job-expire-duration", "", Opt.JobExpireDuration, "Expire finished async jobs older than this value", "RC")
flags.DurationVarP(flagSet, &Opt.JobExpireInterval, "rc-job-expire-interval", "", Opt.JobExpireInterval, "Interval to check for expired async jobs", "RC")
rc: fix missing --rc flags In this commit we accidentally removed the global --rc flags. 0df7466d2b077138 cmd/rcd: Fix command docs to include command specific prefix (#6675) This re-instates them.
2023-03-23 20:04:17 +08:00
Opt.HTTP.AddFlagsPrefix(flagSet, FlagPrefix)
Opt.Auth.AddFlagsPrefix(flagSet, FlagPrefix)
Opt.Template.AddFlagsPrefix(flagSet, FlagPrefix)
Implement Remote Control for rclone #2111 This implements a remote control protocol activated with the --rc flag and a new command `rclone rc` to use that interface. Still to do * docs - need finishing * tests
2018-03-05 19:44:16 +08:00
}
Reference in New Issue Copy Permalink