Skip to content

Commit f87e752

Browse files
edwardfoylejhockett
authored andcommitted
add shared files in CLI file reference page (#5071)
* add CLI shared state files to file reference page * Update src/pages/cli/reference/files.mdx Co-authored-by: John Hockett <[email protected]> --------- Co-authored-by: John Hockett <[email protected]>
1 parent 8031be4 commit f87e752

File tree

1 file changed

+30
-8
lines changed

1 file changed

+30
-8
lines changed

src/pages/cli/reference/files.mdx

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
export const meta = {
22
title: `Files and Folders`,
3-
description: `Learn more about the files and folders Amplify uses to maintain project state.`,
3+
description: `Learn more about the files and folders Amplify uses to maintain project state.`
44
};
55

66
## Folders
@@ -36,8 +36,7 @@ Contains the current cloud state of the checked out environment's resources. The
3636
3737
> Add to version control: YES
3838
39-
Contains the latest local development state of the checked out environment's resources. The contents of this folder can be modified and running `amplify push` will push changes in this directory to the cloud.
40-
Each plugin stores contents in its own subfolder within this folder.
39+
Contains the latest local development state of the checked out environment's resources. The contents of this folder can be modified and running `amplify push` will push changes in this directory to the cloud. Each plugin stores contents in its own subfolder within this folder.
4140

4241
### amplify/mock-data
4342

@@ -52,6 +51,7 @@ Only created after running `amplify mock api`. It contains the SQLite databases
5251
These files work together to maintain the overall state of the Amplify project such as what resources are configured in the project, dependencies between resources, and when the last push was.
5352

5453
### backend-config.json
54+
5555
> Manual edits okay: YES
5656
5757
> Add to version control: YES
@@ -83,17 +83,15 @@ Because one category might create multiple services within one project (e.g. the
8383
}
8484
```
8585

86-
The metadata for each service is first logged into the meta file after the `amplify <category> add` command is executed, containing some general information that indicates one service of the category has been added locally.
87-
Then, on the successful execution of the `amplify push` command, the `output` object will be added/updated in the service's metadata with information that describes the actual cloud resources that have been created or updated.
86+
The metadata for each service is first logged into the meta file after the `amplify <category> add` command is executed, containing some general information that indicates one service of the category has been added locally. Then, on the successful execution of the `amplify push` command, the `output` object will be added/updated in the service's metadata with information that describes the actual cloud resources that have been created or updated.
8887

8988
### aws-exports.js
9089

9190
> Manual edits okay: NO
9291
9392
> Add to version control: NO
9493
95-
This file is generated only for JavaScript projects.
96-
It contains the consolidated outputs from all the categories and is placed under the `src` directory specified during the `init` process. It is updated after `amplify push`.
94+
This file is generated only for JavaScript projects. It contains the consolidated outputs from all the categories and is placed under the `src` directory specified during the `init` process. It is updated after `amplify push`.
9795

9896
This file is consumed by the [Amplify](https://github.com/aws-amplify/amplify-js) JavaScript library for configuration. It contains information which is non-sensitive and only required for external, unauthenticated actions from clients (such as user registration or sign-in flows in the case of Auth) or for constructing appropriate endpoint URLs after authorization has taken place. Please see the following more detailed explanations:
9997

@@ -156,7 +154,7 @@ Used to share project info within your team. Learn more at [Share single environ
156154
157155
> Add to version control: YES
158156
159-
Contains feature flag configuration for the project. If this file does not exist, it is created by Amplify CLI during `amplify init`. Environment specific feature flag overrides can also be defined in `cli.<environment name>.json`. If an environment specific file exists for the currently checked out environment, during `amplify env add` command the same file will be copied for the newly created environment as well. Learn more at [Feature flags](/cli/reference/feature-flags).
157+
Contains feature flag configuration for the project. If this file does not exist, it is created by Amplify CLI during `amplify init`. Environment specific feature flag overrides can also be defined in `cli.<environment name>.json`. If an environment specific file exists for the currently checked out environment, during `amplify env add` command the same file will be copied for the newly created environment as well. Learn more at [Feature flags](/cli/reference/feature-flags).
160158

161159
## General Category Files
162160

@@ -234,3 +232,27 @@ Contains internal metadata about how the CLI should build and invoke the functio
234232
> Add to version control: YES
235233
236234
Contains configuration about how to interpret the GraphQL schema and transform it into AppSync resolvers. Run `amplify api update` to change API category configuration.
235+
236+
## Shared State Files
237+
238+
These files are stored outside of the Amplify project directory and are used by all installations of Amplify on your machine.
239+
240+
### ~/.amplify/amplify-configuration.json
241+
242+
If you have opted in to [Usage Data](./usage-data) this file contains an installation UUID used to correlate data from your machine.
243+
244+
### ~/.amplify/plugins.json
245+
246+
This is where Amplify keeps track of all the installed Amplify plugins. The file has information on where each plugin is located and what commands are handled by each plugin.
247+
248+
### ~/.amplify/lib
249+
250+
This directory contains files that some plugins need at runtime. For example, the DynamoDB simulator used by `amplify mock`.
251+
252+
### ~/.amplify/bin/amplify (or amplify.exe on Windows)
253+
254+
The Amplify CLI executable.
255+
256+
### ~/.aws/amplify/deployment-secrets.json
257+
258+
Stores OAuth configuration values between the time they are configured using `amplify add auth` or `amplify update auth` and `amplify push`. Once the configuration is pushed it is removed from this file.

0 commit comments

Comments
 (0)