Setup Wizard
Run the GT setup wizard
Usage
npx gtx-cli init
Use this command to run the GT setup wizard.
This command is the same as running setup
, then running configure
.
The wizard will:
- Install the necessary dependencies for your project.
- Help you wrap your JSX content with
<T>
tags (in a React-based project). - Create a
gt.config.json
file in the root of your project. - Generate an API key and project ID for your project.
Dependencies
The init
command will install the following dependencies for your project:
gt-react
orgt-next
(if your project is React-based)gtx-cli
as a dev dependency (if not already installed)
React-based projects
If your project is React-based, the wizard will help setup your project to use gt-react
or gt-next
.
If you are already using a different i18n library, you may need to manually setup your project.
See the React docs or the Next.js docs for more information.
Since the wizard is currently experimental, it is possible that it may not work for all React-based projects. In these cases, you may need to manually setup your project.
If you encounter any issues, please let us know on GitHub.
This part of the wizard can also be ran independently via npx gtx-cli setup
.
gt.config.json
The init
command helps you configure your project's GT settings.
It will create a gt.config.json
file in the root of your project.
The file will contain the following settings:
defaultLocale
: The default locale for your project.locales
: An array of supported locales for your project.files
: This is an object that contains information about the content you want to translate.
For more specific information about the gt.config.json
file, please see the config docs.
This part of the wizard can also be ran independently via npx gtx-cli configure
.
Credentials
The wizard will help you generate an API key and project ID for your project (if they are not already set up).
Please note that the API key and project ID are not required to use gt-react
or gt-next
.
The wizard will add the API key and project ID to your .env.local
file.
If this file does not exist, the wizard will create it and add it to your .gitignore
file.
This part of the wizard can also be ran independently via npx gtx-cli auth
.
How is this guide?