#Getting Started
Getting started with Retype is super quick and you can be up and running within seconds.
Check out the Quick start for the condensed process or continue here with the detailed instructions.
Please see the Retype CLI for full details on each command.
#Prerequisites
Retype is installed using either npm, yarn, or the dotnet CLI.
You only need one of those three package managers as a prerequisite, although all three could be installed on your computer too. It's up to you. 🙌
#Install
It takes just a few seconds to install Retype using any of the following commands. Choose the command based on a package manager you have installed on your computer.
That's it! 🎉 Your new Retype website should be up and running. 🎉
If you already have the dotnet CLI installed on your machine, installing using dotnet tool install retypeapp --global will be the fastest option, but any of the options should install within seconds. They all produce the same result and run with the same performance. The dotnet package size is the smallest.
#Update
Update to the latest release of Retype using one of the following commands for the package manager that you initially installed Retype with. For instance, if you used npm to install Retype, run the npm update command to update Retype locally.
#Uninstall
Done with Retype? It's okay, we understand. 😢
Uninstalling Retype is just as simple as installing. Use the same package manager to uninstall as you did to install. For instance, if you used npm to install Retype, run the npm uninstall command to remove.
All Retype related files and folders within your project can be deleted, such as the retype.yml file and the generated .retype folder.
#Version and Tag specific
When managing project dependencies, it is sometimes necessary to install a specific version or a tagged release of a software package to ensure compatibility or access to certain features.
NPM, Yarn, and dotnet offer their own syntax and methods for specifying which version or tag of a software package to install, enabling precise control over the dependencies of your projects.
When using NPM or Yarn, specifying the @latest tag will always install the latest public release. The @latest is optional. If no @version or @tag is provided, Retype will install the @latest release by default.
Using the @next tag will install an upcoming -preview release, if available.
In the following samples, replace [version-or-tag] with the actual version number or tag. For instance, to specifically install the v3.5.0 release of Retype using NPM, run the command npm install retypeapp@3.5.0 --global.
#Platform specific
The default retypapp NPM package is a bundle of several platform specific packages. The installer will automatically detect and choose the correct platform package from the bundle during installation.
The bundle provides convenience although at the cost of an increased download size.
The dotnet package installer will automatically download the platform specific package.
For NPM and Yarn, it is possible to install smaller platform specific packages without the bundling. Currently, three separate platforms are supported and can be installed independently from the primary retypeapp package.