package
2.6.2+incompatible
Repository: https://github.com/10gen/realm-cli.git
Documentation: pkg.go.dev
# Functions
AddAuthProvider adds an auth provider to the provided app data.
AddDataSource adds a data source to the app data.
AsApp converts the realm.App into a local app.
FindApp searches upwards for the root of a Realm app project and returns the local app structure, a boolean indicating if the current working directory is part of a Realm app project, and any error that occurs.
FindAppHosting finds the local Realm app hosting files.
FindNodeModules finds the Realm app dependencies as a node_modules archive.
FindPackageJSON finds the Realm app dependencies as a package.json file.
FindReadme finds the Realm app README file for the specified template.
LoadApp will load the local app data and app config.
LoadEnvironments returns a list of each profile's environment containing name, filepath, and api keys.
MarshalJSON returns the json representation of the passed in interface.
NewApp returns a new local app.
NewAppConfigJSON returns app config.json data.
NewAppRealmConfigJSON returns app realm_config.json data.
NewAppStitchJSON returns app stitch.json data.
WriteFile writes the file to the specified path with the specified permissions.
WriteHostingAssets writes the hosting assets to disk.
WriteZip writes the zip contents to the specified filepath.
# Constants
BackendPath is the relative path to write app contents to when we have templates.
FrontendPath is the relative path to write frontend templates' contents to.
set of supported local names.
auth.
set of supported local names.
set of supported local names.
set of supported local names.
set of supported local names.
Data API Config.
services.
set of supported local names.
cli utilities.
environments.
set of supported local names.
functions.
graphql.
hosting.
set of supported local names.
set of supported local names.
log forwarders.
set of supported local names.
set of supported local names.
set of supported local names.
app configs.
set of supported local names.
set of supported local names.
set of supported local names.
set of supported local names.
values.
set of supported local names.
set of supported local names.
set of supported local names.
sync.
triggers.
set of supported local names.
# Variables
cli utilities.
set of supported local files.
auth.
Data API Config.
data sources.
set of supported local files.
app configs.
set of supported local files.
set of supported local files.
set of supported local files.
values.
functions.
set of supported local files.
# Structs
App is the Realm app data represented on the local filesystem.
AppConfigJSON is the app config.json data.
AppDataV1 is the v1 local Realm app data.
AppDataV2 is the v2 local Realm app data.
AppMeta represents the app's metadata.
AppRealmConfigJSON is the app realm_config.json data.
AppStitchJSON is the app stitch.json data.
AppStructureV1 represents the v1 Realm app structure.
AppStructureV2 represents the v2 Realm app structure.
AuthStructure represents the v2 Realm app auth structure.
Credentials are the apikeys associated with the profiles.
DataSourceStructure represents the v2 Realm app data source structure.
Dependencies holds the data related to a local Realm app's dependencies.
EndpointStructure represents the v2 Realm app http endpoint structure.
Environment contains the name, full filepath, and credentials of a profile.
File is a local Realm app file.
FunctionsStructure represents the v2 Realm app functions structure.
GraphQLStructure represents the Realm app graphql structure.
Hosting is the local Realm app hosting.
HostingDiffs are the hosting asset differences between a local and remote Realm app.
HTTPServiceStructure represents the v2 Realm app http endpoint structure.
ModifiedHostingAsset is a Realm hosting asset with information about its local file changes.
SecretsStructure represents the Realm app secrets.
ServiceStructure represents the Realm app service structure.
SyncStructure represents the v2 Realm app sync structure.
# Interfaces
AppData is the Realm app data.
HostingAssetClient is the hosting asset client.