Documentation ¶
Overview ¶
Source for the wash executable.
To extend wash, see documentation for the 'plugin' package.
Directories ¶
Path | Synopsis |
---|---|
Package activity provides tools for recording wash operations to journals stored in the user's cache directory.
|
Package activity provides tools for recording wash operations to journals stored in the user's cache directory. |
Package analytics provides tools for sending over Wash events and screenviews to Google Analytics
|
Package analytics provides tools for sending over Wash events and screenviews to Google Analytics |
client
Package client provides helpers for interacting with the wash socket HTTP API.
|
Package client provides helpers for interacting with the wash socket HTTP API. |
fs
Package apifs is used by the Wash API to convert local files/directories into Wash entries
|
Package apifs is used by the Wash API to convert local files/directories into Wash entries |
types
Package apitypes declares types common to the API client and server.
|
Package apitypes declares types common to the API client and server. |
Package cmd implements Wash's CLI using https://github.com/spf13/cobra.
|
Package cmd implements Wash's CLI using https://github.com/spf13/cobra. |
internal/config
Package config implements configuration for the wash executable using https://github.com/spf13/viper.
|
Package config implements configuration for the wash executable using https://github.com/spf13/viper. |
internal/find
Package find stores all the logic for `wash find`.
|
Package find stores all the logic for `wash find`. |
internal/find/params
Package params represents `wash find`'s parameters.
|
Package params represents `wash find`'s parameters. |
internal/find/primary/meta
Package meta contains all the parsing logic for the `meta` primary
|
Package meta contains all the parsing logic for the `meta` primary |
util
Package cmdutil provides utilities for formatting CLI output.
|
Package cmdutil provides utilities for formatting CLI output. |
version
Package version reports Wash's version
|
Package version reports Wash's version |
Package datastore implements structured data storage for wash server functionality.
|
Package datastore implements structured data storage for wash server functionality. |
Package fuse adapts wash plugin types to a FUSE filesystem.
|
Package fuse adapts wash plugin types to a FUSE filesystem. |
Package plugin defines a set of interfaces that plugins must implement to enable wash functonality.
|
Package plugin defines a set of interfaces that plugins must implement to enable wash functonality. |
aws
Package aws presents a filesystem hierarchy for AWS resources.
|
Package aws presents a filesystem hierarchy for AWS resources. |
docker
Package docker presents a filesystem hierarchy for Docker resources.
|
Package docker presents a filesystem hierarchy for Docker resources. |
gcp
Package gcp presents a filesystem hierarchy for Google Cloud Platform resources.
|
Package gcp presents a filesystem hierarchy for Google Cloud Platform resources. |
kubernetes
Package kubernetes presents a filesystem hierarchy for Kubernetes resources.
|
Package kubernetes presents a filesystem hierarchy for Kubernetes resources. |
Package volume provides helpers for representing a remote filesystem.
|
Package volume provides helpers for representing a remote filesystem. |
Click to show internal directories.
Click to hide internal directories.