|
| 1 | +# .redwood |
| 2 | + |
| 3 | +## What is this directory? |
| 4 | + |
| 5 | +Cedar uses this `.redwood` directory to store transitory data that aids in the smooth and convenient operation of your Cedar project. |
| 6 | + |
| 7 | +## Do I need to do anything with this directory? |
| 8 | + |
| 9 | +No. You shouldn't have to create, edit or delete anything in this directory in your day-to-day work with Cedar. |
| 10 | + |
| 11 | +You don't need to commit any other contents of this directory to your version control system. It's ignored by default. |
| 12 | + |
| 13 | +## What's in this directory? |
| 14 | + |
| 15 | +### Files |
| 16 | + |
| 17 | +| Name | Description | |
| 18 | +| :---------------- | :----------------------------------------------------------------------------------------------------------------- | |
| 19 | +| commandCache.json | This file contains mappings to assist the Cedar CLI in efficiently executing commands. | |
| 20 | +| schema.graphql | This is the GraphQL schema which has been automatically generated from your Cedar project. | |
| 21 | +| telemetry.txt | Contains a unique ID used for telemetry. This value is rotated every 24 hours to protect your project's anonymity. | |
| 22 | +| test.db | The sqlite database used when running tests. | |
| 23 | + |
| 24 | +### Directories |
| 25 | + |
| 26 | +| Name | Description | |
| 27 | +| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------- | |
| 28 | +| locks | Stores temporary files that Cedar uses to keep track of the execution of async/background tasks between processes. | |
| 29 | +| logs | Stores log files for background tasks such as update checking. | |
| 30 | +| prebuild | Stores transpiled JavaScript that is generated as part of Cedar's build process. | |
| 31 | +| telemetry | Stores the recent telemetry that the Cedar CLI has generated. You may inspect these files to see everything Cedar is anonymously collecting. | |
| 32 | +| types | Stores the results of type generation. | |
| 33 | +| updateCheck | Stores a file which contains the results of checking for Cedar updates. | |
| 34 | +| studio | Used to store data for `rw studio` | |
| 35 | + |
| 36 | +We try to keep this README up to date but you may, from time to time, find other files or directories in this `.redwood` directory that have not yet been documented here. This is likely nothing to worry about but feel free to let us know and we'll update this list. |
| 37 | + |
| 38 | +### Telemetry |
| 39 | + |
| 40 | +CedarJS collects completely anonymous telemetry data about general usage. For transparency, that data is viewable in the respective directories and files. To learn more and manage your project's settings, visit [telemetry.redwoodjs.com](https://telemetry.redwoodjs.com). |
| 41 | + |
| 42 | +### Have any questions? |
| 43 | + |
| 44 | +Feel free to reach out to us in the [RedwoodJS Community](https://community.redwoodjs.com/) forum if you have any questions. |
0 commit comments