The **Pseudo Engine** is a powerful developer-first AI tool that focuses on **structured AI code-gen**, **AI-safe versioning**, and **codebase visibility/readability**.
### Quick links:
[[Installation]]
[[Syntax]]
[[CLI]]
[[Examples]]
## Getting Started
First, Install the command line tool. To do so, follow our [[Installation]] guide.
Run `pseudo version` to ensure CLI is installed correctly.
##### IDE Plugins/Extensions
**JetBrains Plugins**: Pending approval
**VS Code Extensions**: Pseudo Engine by LaunchCo
**Cursor**: Same as VS Code
The **Pseudo Engine** is designed to work from the root directory of any codebase.
From the root directory run `pseudo init` in your terminal. Pseudo will begin creating a clone of your codebase in Pseudo Code.
This will add a `pseudo` directory in your root directory. The pseudo directory is structured as follows:
```
pseudo/
├── src
│ ├── Copy of codebase in Pseudo Code
├── .cache
│ ├── Version controlled copy of codebase and metadata
└── config.pseudo # Configuration file
```
Once the `pseudo init` has finished running ***navigate to the `config.pseudo` file and fill out tech_stack and description (remove the comments as well).*
Now you're all set! The Pseudo Engine is initialized and ready to use.
`pseudo sync` reads from source code and writes to pseudo code.
`pseudo gen` reads from pseudo code and writes to source code.
Use these accordingly. If you edit source code and pseudo code and run `pseudo sync` it can overwrite the pseudo code.
Use `sync` when editing source code and use `gen` to AI generate source code from your Pseudo Code.
Every time you run `pseudo gen` and it detects changes in the Pseudo Code it will automatically create a new version before generating any code.
Run `pseudo rollback` to rollback the generated changes.
You can run `pseudo preview <version>` to see any version of your codebase within the pseudo .cache, i.e. `pseudo preview 1.4`.
Run `pseudo latest` to return to the latest version.
Run `pseudo set` to set current preview version as latest version.