clicore

package module

Go to main page

Versions in this module

v0

v0.8.0

Jul 23, 2026

v0.7.0

Jul 23, 2026

v0.6.0

Jul 23, 2026

v0.5.1

Jul 23, 2026

Changes in this version

type UploadCreateRequest

+ Note string

v0.5.0

Jul 22, 2026

Changes in this version

type Client

+ func (c *Client) ExposeDeviceToContact(ctx context.Context, email, deviceSessionID string) error

+ func (c *Client) ListExposedDevicesForContact(ctx context.Context, email string) ([]string, error)

+ func (c *Client) UnexposeDeviceFromContact(ctx context.Context, email, deviceSessionID string) error

v0.4.1

Jul 22, 2026

v0.4.0

Jul 21, 2026

Changes in this version

+ func ExpiryForAPI(value string) (expiresIn string, noExpiry bool, err error)

type UploadCreateRequest

+ NoExpiry bool

v0.3.4

Jul 19, 2026

v0.3.3

Jul 19, 2026

v0.3.2

Jul 19, 2026

v0.3.1

Jul 19, 2026

v0.3.0

Jul 19, 2026

v0.2.1

Jul 18, 2026

v0.2.0

Jul 18, 2026

v0.1.0

Jul 18, 2026

Changes in this version

+ const APIBaseSourceConfig

+ const APIBaseSourceDefault

+ const APIBaseSourceEnv

+ const APITokenEnv

+ const APITokenPrefix

+ const ContentClassFolder

+ const CredentialSchemaVersion

+ const DefaultAPIBase

+ const DefaultBaseURL

+ const DefaultSecretScanMaxBytes

+ const DefaultShareBase

+ const EncryptionAlgoAES256GCM

+ const PendingResealTTL

+ const QRContentMaxBytes

+ const QRContentWarnBytes

+ var BuildVersion = "dev"

+ var DefaultHTTPClient = http.DefaultClient

+ var ErrInvalidKey = errors.New("invalid encryption key")

+ var P2PEnabled = "false"

+ var Version = "dev"

+ func APIBaseFromBaseURL(baseURL string) (string, error)

+ func CacheBaseDir() (string, error)

+ func CacheEntryIsLocal(entry CacheEntry) bool

+ func CacheManifestPath() (string, error)

+ func CacheObjectsDir() (string, error)

+ func ConfigPath() (string, error)

+ func ContentClassForNameAndType(name, contentType string) string

+ func CredentialPath() (string, error)

+ func DecodeKey(encoded string) ([]byte, error)

+ func DecryptStream(dst io.Writer, src io.Reader, key []byte) error

+ func DefaultExpiry() string

+ func DeleteCredential() error

+ func DownloadGatewayURL(apiBase, publicID string) (string, error)

+ func DurationForAPI(value string) (string, error)

+ func EncodeKey(key []byte) string

+ func EncryptStream(dst io.Writer, src io.Reader, key []byte) error

+ func EnvAPIToken() string

+ func FileSHA256(path string) (string, error)

+ func ForgetRetainedKey(sharePublicID string) error

+ func FullVersion() string

+ func IsAPIToken(token string) bool

+ func IsAuthorizationPending(err error) bool

+ func IsDeviceLimitReached(err error) bool

+ func IsHighConfidenceSecretRule(ruleID string) bool

+ func KeyFromShareURL(raw string) ([]byte, error)

+ func ListIndexPath() (string, error)

+ func NewDataKey() ([]byte, error)

+ func NewInstallID() string

+ func NormalizeAPIHost(value string) (string, error)

+ func NormalizeBaseURL(value string) (string, error)

+ func NormalizeShareBase(value string) (string, error)

+ func OpenBrowser(rawURL string) error

+ func OpenSealedContentKey(sealedKey, publicKey, privateKey string) ([]byte, error)

+ func P2PStreamingEnabled() bool

+ func ParseDuration(value string) (time.Duration, error)

+ func PendingResealPath() (string, error)

+ func QRIsText(b []byte) bool

+ func RandomTip(command string) string

+ func RedactSecretFinding(match, secret string) string

+ func RenderQR(content string) (string, error)

+ func ResolveAPIBase() (string, string, error)

+ func ResolveBaseURL() (string, string, error)

+ func ResolveShareBase() (string, string, error)

+ func RetainContentKey(sharePublicID, contentKeyB64, recipientEmail string) error

+ func SaveCacheManifest(manifest CacheManifest) error

+ func SaveCacheManifestAt(path string, manifest CacheManifest) error

+ func SaveConfig(config Config) error

+ func SaveConfigAt(path string, config Config) error

+ func SaveCredential(credential Credential) error

+ func SaveCredentialAt(path string, credential Credential) error

+ func SaveListIndex(entries []ListIndexEntry) error

+ func SaveListIndexAt(path string, entries []ListIndexEntry) error

+ func SavePendingReseal(store PendingResealStore) error

+ func SaveSourceRegistry(registry SourceRegistry) error

+ func SaveSourceRegistryAt(path string, registry SourceRegistry) error

+ func SaveUpdateCheckCache(cache UpdateCheckCache) error

+ func SaveUpdateCheckCacheAt(path string, cache UpdateCheckCache) error

+ func SealContentKeyForDevice(contentKey []byte, targetPublicKey string) (string, error)

+ func SecretFindingsError(count int) error

+ func ShareBaseFromBaseURL(baseURL string) (string, error)

+ func ShareURLWithKey(base, publicID string, key []byte) string

+ func SleepInterval(interval int) time.Duration

+ func SourceRefForPath(path string) (string, string, error)

+ func SourceRegistryPath() (string, error)

+ func Tips(command string) []string

+ func UpdateCheckCachePath() (string, error)

+ func Usage(command string) string

+ func VerificationURL(code DeviceCodeResponse) string

+ type APIError struct

+ Code string

+ DeviceLimit *DeviceLimitDetails

+ Message string

+ RequestID string

+ Status int

+ func (e *APIError) Error() string

+ type APITokenInfo struct

+ ExpiresAt string

+ ID string

+ Label string

+ Scopes []string

+ TokenHint string

+ type AccessControlsRequest struct

+ AllowedDomains []string

+ DeniedDomains []string

+ MaxViews uint64

+ type AnalyticsTimelinePoint struct

+ Date string

+ Downloads uint64

+ Views uint64

+ type CacheEntry struct

+ FileName string

+ Path string

+ PulledAt time.Time

+ SHA256 string

+ SizeBytes uint64

+ type CacheManifest map[string]CacheEntry

+ func AddCacheEntry(manifest CacheManifest, publicID string, entry CacheEntry) CacheManifest

+ func LoadCacheManifest() (CacheManifest, error)

+ func LoadCacheManifestAt(path string) (CacheManifest, error)

+ func RemoveCacheEntry(manifest CacheManifest, publicID string) CacheManifest

+ type Client struct

+ BaseURL string

+ HTTPClient *http.Client

+ Token string

+ func NewClient(apiBase, token string) *Client

+ func (c *Client) AckInboxShare(ctx context.Context, publicID string) error

+ func (c *Client) ApprovePendingInbox(ctx context.Context, publicID string) error

+ func (c *Client) AuthorizeP2PRoom(ctx context.Context, room, role string) (P2PRoomAuth, error)

+ func (c *Client) CheckUpdate(ctx context.Context, version, osName, arch string) (UpdateCheckResponse, error)

+ func (c *Client) CompleteUpload(ctx context.Context, uploadSessionID string) (UploadCompleteResponse, error)

+ func (c *Client) CreateAPIToken(ctx context.Context, label string, scopes []string, expiresInDays *int) (CreateAPITokenResponse, error)

+ func (c *Client) CreateReplaceUpload(ctx context.Context, publicID string, upload UploadCreateRequest) (UploadCreateResponse, error)

+ func (c *Client) CreateUpload(ctx context.Context, upload UploadCreateRequest) (UploadCreateResponse, error)

+ func (c *Client) DeleteShare(ctx context.Context, publicID string) error

+ func (c *Client) DeleteTeammateSender(ctx context.Context, email string) error

+ func (c *Client) DisableShare(ctx context.Context, publicID string) (Share, error)

+ func (c *Client) DownloadInboxContent(ctx context.Context, publicID string, dst io.Writer) error

+ func (c *Client) DownloadURL(ctx context.Context, rawURL string, dst io.Writer) error

+ func (c *Client) EnableShare(ctx context.Context, publicID string) (Share, error)

+ func (c *Client) ExtendExpiry(ctx context.Context, publicID string, expiresIn time.Duration) (Share, error)

+ func (c *Client) FlushShare(ctx context.Context, publicID string) (LiveFlushResponse, error)

+ func (c *Client) GetOnboarding(ctx context.Context) (OnboardingStatus, error)

+ func (c *Client) GetShare(ctx context.Context, publicID string) (Share, error)

+ func (c *Client) GetTeammatePolicy(ctx context.Context) (TeammatePolicy, error)

+ func (c *Client) Inbox(ctx context.Context) (InboxResponse, error)

+ func (c *Client) ListDevices(ctx context.Context) (ListDevicesResponse, error)

+ func (c *Client) ListPendingInbox(ctx context.Context) (PendingInboxResponse, error)

+ func (c *Client) ListShares(ctx context.Context) (ListSharesResponse, error)

+ func (c *Client) Logout(ctx context.Context) error

+ func (c *Client) Me(ctx context.Context) (MeResponse, error)

+ func (c *Client) PollDeviceToken(ctx context.Context, deviceCode string) (DeviceTokenResponse, error)

+ func (c *Client) PutLive(ctx context.Context, publicID string, request LivePutRequest) (LivePutResponse, error)

+ func (c *Client) PutUpload(ctx context.Context, upload PresignedUpload, body io.Reader, size int64) error

+ func (c *Client) RegisterDeviceKey(ctx context.Context, publicKey string) error

+ func (c *Client) RejectPendingInbox(ctx context.Context, publicID string) error

+ func (c *Client) ReportInstall(ctx context.Context, e InstallEvent) error

+ func (c *Client) ResealQueue(ctx context.Context) (ResealQueueResponse, error)

+ func (c *Client) RevokeAllShares(ctx context.Context) (RevokeAllResponse, error)

+ func (c *Client) RevokeDeviceSession(ctx context.Context, sessionID string) error

+ func (c *Client) RevokeDeviceSessionWithDeviceCode(ctx context.Context, deviceCode, sessionID string) error

+ func (c *Client) RevokeShare(ctx context.Context, publicID string) (Share, error)

+ func (c *Client) SetTeammatePolicy(ctx context.Context, mode string) error

+ func (c *Client) SetTeammateSender(ctx context.Context, email, mode string) error

+ func (c *Client) ShareAnalytics(ctx context.Context, publicID string) (ShareAnalyticsResponse, error)

+ func (c *Client) StartDeviceCode(ctx context.Context, request ...DeviceCodeRequest) (DeviceCodeResponse, error)

+ func (c *Client) SubmitConsent(ctx context.Context, version string) error

+ func (c *Client) SubmitReseal(ctx context.Context, publicID, targetSessionID, sealedKey string) error

+ func (c *Client) TeammateDevices(ctx context.Context, email string) (TeammateDeviceList, error)

+ func (c *Client) UpdateAccessControls(ctx context.Context, publicID string, controls AccessControlsRequest) (Share, error)

+ func (c *Client) Usage(ctx context.Context) (UsageResponse, error)

+ type Config struct

+ BaseURL string

+ Defaults *UploadDefaults

+ Devices []DeviceAlias

+ Host string

+ InstallID string

+ InstallReported bool

+ MachineID string

+ Reshare *bool

+ ShareBase string

+ TrustedPeers []string

+ func LoadConfig() (Config, error)

+ func LoadConfigAt(path string) (Config, error)

+ func (c *Config) DeleteDeviceAlias(name string) bool

+ func (c *Config) DeleteTrustedPeer(ref string) bool

+ func (c *Config) SetDeviceAlias(name, addr string)

+ func (c *Config) SetTrustedPeer(ref string)

+ func (c Config) ResolveDeviceAlias(name string) (string, bool)

+ func (c Config) ResolvedReshareDefault() *bool

+ func (c Config) TrustedIPs() []string

+ type CreateAPITokenResponse struct

+ APIToken APITokenInfo

+ Token string

+ type Credential struct

+ APIBase string

+ DevicePrivateKey string

+ DevicePublicKey string

+ DeviceSessionID string

+ Email string

+ SchemaVersion int

+ Token string

+ func LoadCredential() (Credential, error)

+ func LoadCredentialAt(path string) (Credential, error)

+ type DeviceAlias struct

+ Addr string

+ Name string

+ type DeviceCodeRequest struct

+ Arch string

+ ClientVersion string

+ DeviceName string

+ MachineID string

+ OS string

+ type DeviceCodeResponse struct

+ DeviceCode string

+ ExpiresIn int

+ Interval int

+ UserCode string

+ VerificationURI string

+ VerificationURIComplete string

+ type DeviceKeyPair struct

+ PrivateKey string

+ PublicKey string

+ func NewDeviceKeyPair() (DeviceKeyPair, error)

+ type DeviceLimitDetails struct

+ Limit int

+ Sessions []DeviceSession

+ func DeviceLimitDetailsFromError(err error) (DeviceLimitDetails, bool)

+ type DeviceMetadata struct

+ Arch string

+ DeviceName string

+ Hostname string

+ MachineID string

+ OS string

+ func DetectDeviceMetadata(deviceName string) (DeviceMetadata, error)

+ type DeviceSession struct

+ ClientType string

+ CreatedAt string

+ Current bool

+ DeviceName string

+ ExpiresAt string

+ ID string

+ LastUsedAt string

+ MachineID string

+ PublicKey string

+ type DeviceTokenResponse struct

+ Credential string

+ DeviceSessionID string

+ ExpiresAt string

+ Scopes []string

+ type InboxResponse struct

+ Shares []InboxShare

+ type InboxShare struct

+ ContentClass string

+ ContentType string

+ CreatedAt string

+ ExpiresAt string

+ FileName string

+ FromDeviceName string

+ PublicID string

+ SealedKey string

+ SizeBytes uint64

+ type InstallEvent struct

+ Arch string

+ EventType string

+ InstallID string

+ OS string

+ Version string

+ type ListDevicesResponse struct

+ Sessions []DeviceSession

+ type ListIndexEntry struct

+ FileName string

+ PublicID string

+ Serial int

+ func LoadListIndex() ([]ListIndexEntry, error)

+ func LoadListIndexAt(path string) ([]ListIndexEntry, error)

+ type ListSharesResponse struct

+ Shares []Share

+ type LiveFlushResponse struct

+ PublicID string

+ SHA256 string

+ Size uint64

+ Version uint64

+ type LivePutRequest struct

+ CRC32 string

+ Content string

+ ContentType string

+ type LivePutResponse struct

+ CRC32 string

+ Changed bool

+ Size uint64

+ TTLSeconds int

+ type MeResponse struct

+ AccountID string

+ Email string

+ MCPEnabled *bool

+ PlanID string

+ PlanName string

+ Scopes []string

+ Source string

+ UserID string

+ type OnboardingStatus struct

+ ConsentRequired bool

+ ConsentVersion string

+ Onboarded bool

+ type P2PICEServer struct

+ Credential string

+ URLs []string

+ Username string

+ type P2PRoomAuth struct

+ ExpiresAt string

+ ICEServers []P2PICEServer

+ RelayURL string

+ Role string

+ Room string

+ Token string

+ type PendingInboxResponse struct

+ Shares []PendingInboxShare

+ type PendingInboxShare struct

+ ContentType string

+ CreatedAt string

+ ExpiresAt string

+ FileName string

+ FromDeviceName string

+ PublicID string

+ SenderEmail string

+ SizeBytes uint64

+ type PendingResealEntry struct

+ ContentKey string

+ CreatedAt time.Time

+ RecipientEmail string

+ SharePublicID string

+ type PendingResealStore map[string]PendingResealEntry

+ func LoadPendingReseal() (PendingResealStore, error)

+ type PresignedUpload struct

+ Headers map[string]string

+ Method string

+ URL string

+ type ResealEntry struct

+ PublicKey string

+ RecipientEmail string

+ ShareID string

+ TargetSessionID string

+ type ResealQueueResponse struct

+ Requests []ResealEntry

+ type RevokeAllResponse struct

+ Revoked uint64

+ type SecretFinding struct

+ Description string

+ Entropy float32

+ HighConfidence bool

+ Line int

+ Redacted string

+ RuleID string

+ type SecretScanOptions struct

+ MaxBytes int64

+ type SecretScanResult struct

+ Findings []SecretFinding

+ ScannedBytes int64

+ SkipReason string

+ Skipped bool

+ Truncated bool

+ func ScanBytesForSecrets(content []byte, opts SecretScanOptions) (SecretScanResult, error)

+ func ScanFileForSecrets(path string, opts SecretScanOptions) (SecretScanResult, error)

+ func (r SecretScanResult) HasHighConfidenceSecret() bool

+ type Share struct

+ AllowedDomains []string

+ ContentClass string

+ CreatedAt string

+ DeniedDomains []string

+ DeviceName string

+ DeviceSessionID string

+ Disabled bool

+ DisabledAt string

+ DownloadCount uint64

+ Encrypted bool

+ EncryptionAlgo string

+ ExpiresAt string

+ FileName string

+ LiveUpdate bool

+ MaxDownloads uint64

+ MaxViews uint64

+ PublicID string

+ RecipientRestricted bool

+ Recipients []string

+ SHA256 string

+ SizeBytes uint64

+ Status string

+ Version uint64

+ ViewCount uint64

+ type ShareAccessEvent struct

+ Client string

+ Country string

+ EventType string

+ IP string

+ OccurredAt string

+ type ShareAnalyticsResponse struct

+ Downloads uint64

+ FirstAccessedAt string

+ LastAccessedAt string

+ Recent []ShareAccessEvent

+ Timeline []AnalyticsTimelinePoint

+ UniqueVisitors uint64

+ Views uint64

+ type ShareRef struct

+ Link string

+ LiveUpdate bool

+ PublicID string

+ Targeted bool

+ Version uint64

+ type SourceRegistry map[string]SourceRegistryEntry

+ func AddSourceRegistryEntry(registry SourceRegistry, absPath string, entry SourceRegistryEntry) SourceRegistry

+ func LoadSourceRegistry() (SourceRegistry, error)

+ func LoadSourceRegistryAt(path string) (SourceRegistry, error)

+ type SourceRegistryEntry struct

+ Link string

+ PublicID string

+ type TeammateDevice struct

+ DeviceID string

+ PublicKey string

+ type TeammateDeviceList struct

+ Code string

+ Devices []TeammateDevice

+ Mode string

+ type TeammatePolicy struct

+ Mode string

+ Senders []TeammateSenderPref

+ type TeammateSenderPref struct

+ Email string

+ Mode string

+ type UpdateCheckCache struct

+ LastCheckedAt time.Time

+ LatestVersion string

+ func LoadUpdateCheckCache() (UpdateCheckCache, error)

+ func LoadUpdateCheckCacheAt(path string) (UpdateCheckCache, error)

+ type UpdateCheckResponse struct

+ CurrentVersion string

+ Downloads UpdateDownloads

+ LatestVersion string

+ Platform string

+ UpdateAvailable bool

+ type UpdateDownloads struct

+ ArchiveURL string

+ CRC32 string

+ CRC32URL string

+ SHA256 string

+ SizeBytes int64

+ type UploadCompleteResponse struct

+ ExpiresAt string

+ PublicID string

+ Status string

+ Version uint64

+ type UploadCreateRequest struct

+ AllowReshare *bool

+ AllowedDomains []string

+ ContentClass string

+ ContentType string

+ DeniedDomains []string

+ Encrypted bool

+ EncryptionAlgo string

+ ExpiresIn string

+ FileName string

+ Live bool

+ MaxViews uint64

+ New bool

+ OneTime bool

+ Password string

+ RecipientEmail string

+ Recipients []string

+ SHA256 string

+ SealedKey string

+ SizeBytes uint64

+ Source string

+ SourceRef string

+ TargetDevice string

+ Targets []UploadTarget

+ type UploadCreateResponse struct

+ EmailSharesRemaining *int

+ ExpiresAt string

+ Link string

+ Share ShareRef

+ SkippedUpload bool

+ Upload PresignedUpload

+ UploadSessionID string

+ type UploadDefaults struct

+ AllowedDomains []string

+ DeniedDomains []string

+ Encrypt *bool

+ Expires *string

+ MaxViews *uint64

+ NoScan *bool

+ Reshare *bool

+ func (d *UploadDefaults) IsEmpty() bool

+ type UploadTarget struct

+ SealedKey string

+ TargetDeviceSessionID string

+ type UsageResponse struct

+ ActiveShares uint64

+ AllowedContentClasses []string

+ ClientSideEncryption bool

+ DefaultExpiryHours uint64

+ MaxActiveShares uint64

+ MaxDownloadsPerShare uint64

+ MaxFileSizeBytes uint64

+ MaximumExpiryHours uint64

+ MonthlyUploadBytes uint64

+ MonthlyUploadLimitBytes uint64

+ OneTimeDownload bool

+ PasswordProtection bool

+ StorageQuotaBytes uint64

+ StorageUsedBytes uint64

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL