Documentation
¶
Index ¶
- type ArtworkClientCommands
- type ArtworkCreateCmd
- type ClientCommands
- type GoogleClientCommands
- type GoogleLoginCmd
- type LLMProviderClientCommands
- type LLMProviderCreateCmd
- type MetadataClientCommands
- type MetadataCmd
- type ObjectClientCommands
- type ObjectGetCmd
- type ObjectHeadCmd
- type ObjectListCmd
- type ObjectPutCmd
- type RunServer
- type SearchClientCommands
- type SearchCmd
- type ServerCommands
- type UIFlags
- type VolumeClientCommands
- type VolumeCreateFileCmd
- type VolumeCreateS3Cmd
- type VolumeDeleteCmd
- type VolumeGetCmd
- type VolumeListCmd
- type VolumeMountCmd
- type VolumeReindexCmd
- type VolumeUnmountCmd
- type VolumeUpdateCmd
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArtworkClientCommands ¶ added in v0.2.16
type ArtworkClientCommands struct {
ArtworkCreate ArtworkCreateCmd `cmd:"" name:"artwork-upload" help:"Upload a new artwork." group:"ARTWORK"`
}
type ArtworkCreateCmd ¶ added in v0.2.16
type ArtworkCreateCmd struct {
Path string `cmd:"" name:"path" help:"Path to the artwork file." arg:"" required:""`
}
type ClientCommands ¶
type GoogleClientCommands ¶ added in v0.2.20
type GoogleClientCommands struct {
GoogleLogin GoogleLoginCmd `cmd:"" name:"google-login" help:"Login to the Google." group:"GOOGLE"`
}
type GoogleLoginCmd ¶ added in v0.2.20
type GoogleLoginCmd struct {
ReadOnly bool `name:"read-only" help:"Request read-only access to Google Drive." negatable:""`
ClientID string `name:"client-id" help:"Google OAuth2 client ID." env:"GOOGLE_CLIENT_ID"`
ClientSecret string `name:"client-secret" help:"Google OAuth2 client secret." env:"GOOGLE_CLIENT_SECRET"`
}
type LLMProviderClientCommands ¶ added in v0.2.10
type LLMProviderClientCommands struct {
LLMProviderCreate LLMProviderCreateCmd `cmd:"" name:"llm-create" help:"Create or update an LLM provider." group:"LLM PROVIDER"`
}
type LLMProviderCreateCmd ¶ added in v0.2.10
type LLMProviderCreateCmd struct {
schema.LLMProviderCreate
}
type MetadataClientCommands ¶ added in v0.2.3
type MetadataClientCommands struct {
Metadata MetadataCmd `cmd:"" name:"metadata" help:"Extract metadata for a file using the server endpoint." group:"METADATA"`
}
type MetadataCmd ¶ added in v0.2.3
type MetadataCmd struct {
Path string `arg:"" name:"path" type:"file" help:"Path to the local file."`
}
type ObjectClientCommands ¶ added in v0.2.0
type ObjectClientCommands struct {
ObjectList ObjectListCmd `cmd:"" name:"objects" help:"List server objects." group:"OBJECT"`
ObjectHead ObjectHeadCmd `cmd:"" name:"object" help:"Get object metadata by volume and path." group:"OBJECT"`
ObjectPut ObjectPutCmd `cmd:"" name:"object-upload" help:"Upload an object to a volume." group:"OBJECT"`
ObjectGet ObjectGetCmd `cmd:"" name:"object-download" help:"Download an object from a volume." group:"OBJECT"`
}
type ObjectGetCmd ¶ added in v0.2.20
type ObjectHeadCmd ¶ added in v0.2.25
type ObjectListCmd ¶ added in v0.2.0
type ObjectListCmd struct {
schema.ObjectListRequest
}
type ObjectPutCmd ¶ added in v0.2.24
type RunServer ¶ added in v0.2.0
type RunServer struct {
pgcmd.PostgresFlags
servercmd.RunServer
UIFlags
// Other flags
Indexer bool `long:"indexer" help:"Run this instance as an indexer of content" default:"false" negatable:""`
Passphrases []string `name:"passphrase" env:"${ENV_NAME}_PASSPHRASES" help:"One or more passphrases used to encrypt credentials."`
}
type SearchClientCommands ¶ added in v0.2.10
type SearchClientCommands struct {
Search SearchCmd `cmd:"" name:"search" help:"Search server objects." group:"SEARCH"`
}
type SearchCmd ¶ added in v0.2.10
type SearchCmd struct {
schema.SearchListRequest
}
type ServerCommands ¶
type ServerCommands struct {
RunServer RunServer `cmd:"" name:"run" help:"Run the filer server." group:"SERVER"`
servercmd.OpenAPICommands
}
type UIFlags ¶ added in v0.2.13
type UIFlags struct {
UI bool `long:"ui" help:"Serve the web UI from this server" default:"true" negatable:""`
}
func (*UIFlags) MaybeRegisterUI ¶ added in v0.2.13
type VolumeClientCommands ¶ added in v0.2.0
type VolumeClientCommands struct {
VolumeGet VolumeGetCmd `cmd:"" name:"volume" help:"Get a volume by name." group:"VOLUME"`
VolumeList VolumeListCmd `cmd:"" name:"volumes" help:"List server volumes." group:"VOLUME"`
VolumeCreateFile VolumeCreateFileCmd `cmd:"" name:"volume-create-file" help:"Create a new file-backed volume." group:"VOLUME"`
VolumeCreateS3 VolumeCreateS3Cmd `cmd:"" name:"volume-create-s3" help:"Create a new S3-backed volume." group:"VOLUME"`
VolumeMount VolumeMountCmd `cmd:"" name:"volume-mount" help:"Mount a volume by name." group:"VOLUME"`
VolumeUnmount VolumeUnmountCmd `cmd:"" name:"volume-unmount" help:"Unmount a volume by name." group:"VOLUME"`
VolumeUpdate VolumeUpdateCmd `cmd:"" name:"volume-update" help:"Update a volume by name." group:"VOLUME"`
VolumeDelete VolumeDeleteCmd `cmd:"" name:"volume-delete" help:"Delete a volume by name." group:"VOLUME"`
VolumeReindex VolumeReindexCmd `cmd:"" name:"volume-reindex" help:"Reindex a volume by name." group:"VOLUME"`
}
type VolumeCreateFileCmd ¶ added in v0.2.14
type VolumeCreateS3Cmd ¶ added in v0.2.20
type VolumeCreateS3Cmd struct {
URL *url.URL `arg:"" name:"url" type:"url" help:"S3 URL (s3://bucket-name/prefix)."`
Endpoint *url.URL `name:"endpoint" type:"url" help:"Custom S3 endpoint URL."`
Region string `name:"region" help:"AWS region. Defaults to us-east-1 for custom endpoints."`
Anonymous bool `name:"anonymous" help:"Use anonymous credentials for S3." negatable:""`
AccessKey string `name:"access-key" help:"AWS access credential."`
SecretKey string `name:"secret-key" help:"AWS secret credential."`
SessionToken string `name:"session-token" help:"AWS session token credential."`
}
type VolumeDeleteCmd ¶ added in v0.2.14
type VolumeDeleteCmd struct {
VolumeGetCmd
}
type VolumeGetCmd ¶ added in v0.2.14
type VolumeGetCmd struct {
Name string `arg:"" name:"name" help:"Volume name."`
}
type VolumeListCmd ¶ added in v0.2.7
type VolumeListCmd struct {
schema.VolumeListRequest
}
type VolumeMountCmd ¶ added in v0.2.14
type VolumeMountCmd struct {
VolumeGetCmd
}
type VolumeReindexCmd ¶ added in v0.2.16
type VolumeReindexCmd struct {
VolumeGetCmd
schema.ObjectListFilters
Force bool `json:"force" short:"f" help:"Force reindexing of all objects, even if they are already indexed"`
}
type VolumeUnmountCmd ¶ added in v0.2.14
type VolumeUnmountCmd struct {
VolumeGetCmd
}
type VolumeUpdateCmd ¶ added in v0.2.14
type VolumeUpdateCmd struct {
VolumeGetCmd
schema.VolumeMeta
}
Click to show internal directories.
Click to hide internal directories.