You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
👋 Welcome! This tool can help you easily create new web projects and automatically make advanced codebase modifications, with more features coming soon.
9
+
👋 Welcome! This superapp tool can help you easily create new web projects and automatically make advanced codebase modifications, with more features coming soon.
10
10
11
11
**Reliverse** is a CLI tool designed to streamline the setup of JavaScript, TypeScript, and other types of projects, with a primary focus on Next.js templates, though it is not limited to them.
12
12
13
-
It allows you to effortlessly bootstrap projects, including the [Relivator Next.js template](https://github.com/blefnk/relivator-nextjs-template) or any other template from GitHub or other Git-based sources. Additionally, Reliverse assists in managing configuration files and resolving potential conflicts between tools like ESLint, Prettier, and Biome.
13
+
## Installation
14
+
15
+
Please make sure you have [Git](https://git-scm.com), [VSCode](https://code.visualstudio.com), and [Node.js LTS](https://nodejs.org/en/download/package-manager) installed first.
16
+
17
+
Then use one of the following commands to install **Reliverse**:
18
+
19
+
- With [bun](https://bun.sh): `bun i -g @reliverse/cli`
20
+
- With [pnpm](https://pnpm.io/installation#using-corepack): `pnpm add -g @reliverse/cli`
21
+
- With [yarn](https://yarnpkg.com): `yarn global add @reliverse/cli`
22
+
- With [npm](https://nodejs.org/en/learn/getting-started/an-introduction-to-the-npm-package-manager): `npm i -g @reliverse/cli`
23
+
24
+
## Usage
25
+
26
+
Once installed, you can use **@reliverse/cli** to create new projects or manage existing ones. Navigate to the root of your desired directory and run:
27
+
28
+
```bash
29
+
reliverse
30
+
```
31
+
32
+
## Updating
33
+
34
+
```bash
35
+
bun rm -g @reliverse/cli
36
+
bun i -g @reliverse/cli
37
+
# OR bun update --latest -g
38
+
# OR use another package manager
39
+
```
40
+
41
+
## Introduction
42
+
43
+
A single tool to launch a brand new thing from scratch? Yes.
44
+
45
+
Reliverse allows you to effortlessly bootstrap projects, including the [Relivator Next.js template](https://github.com/blefnk/relivator-nextjs-template) or any other template from GitHub or other Git-based sources. Additionally, Reliverse assists in managing configuration files and resolving potential conflicts between tools like ESLint, Prettier, and Biome.
14
46
15
47
Reliverse is more than just the easiest way to install Relivator. It’s also the most convenient new way to download any repository from GitHub and automatically prepare it for work. Especially if it’s a project from the JavaScript ecosystem.
16
48
@@ -20,7 +52,7 @@ The mission of this project is not only to help you install templates in seconds
20
52
21
53
Things are too overwhelming in our world. Let's make everything easier.
22
54
23
-
**Reliverse CLI allows you:**
55
+
**@reliverse/cli allows you:**
24
56
25
57
1. Install the pre-configured Relivator.
26
58
2. Build your own Relivator from scratch.
@@ -30,7 +62,7 @@ Things are too overwhelming in our world. Let's make everything easier.
30
62
6. Update your GitHub clone with the latest changes.
31
63
7. Add, remove, or replace the Relivator's features.
32
64
33
-
**It's a single tool for everything.** At its current stage, Reliverse CLI is a powerful website builder and project bootstrapper, right in your terminal. However, it won’t be only a website builder in the future, it will be a tool for building anything. Even now, you can start from scratch or with a template, setting everything up automatically or customizing it to your exact preferences. With all the tools pre-configured and ready to go, you can build exactly what you envision.
65
+
**It's a single tool for everything.** At its current stage, @reliverse/cli is a powerful website builder and project bootstrapper, right in your terminal. However, it won’t be only a website builder in the future, it will be a tool for building anything. Even now, you can start from scratch or with a template, setting everything up automatically or customizing it to your exact preferences. With all the tools pre-configured and ready to go, you can build exactly what you envision.
34
66
35
67
Remember the feeling of empowerment when you first used a website builder like WordPress? It gave you the freedom to create. But eventually, you hit limits—PageSpeed Insights flagged issues, performance lagged, and the bloated size of your site became hard to ignore.
36
68
@@ -42,28 +74,15 @@ Reliverse is still in its early stages, but it already allows you to bootstrap w
42
74
43
75
By the way, you might think that a CLI doing so many things would become bloated, like an elephant in the room, but don’t worry—it’s going to be lean. This is the dream of a creator, a dream that must become reality. Everything has to be perfect.
44
76
45
-
## Installation
46
-
47
-
You should install [Git](https://git-scm.com), [VSCode](https://code.visualstudio.com), and [Node.js LTS](https://nodejs.org/en/download/package-manager) first. Then use one of the following commands to install **Reliverse**:
48
-
49
-
- With [bun](https://bun.sh): `bun i -g @reliverse/cli`
50
-
- With [pnpm](https://pnpm.io/installation#using-corepack): `pnpm add -g @reliverse/cli`
51
-
- With [yarn](https://yarnpkg.com): `yarn global add @reliverse/cli`
52
-
- With [npm](https://nodejs.org/en/learn/getting-started/an-introduction-to-the-npm-package-manager): `npm i -g @reliverse/cli`
53
-
54
-
## Usage
55
-
56
-
Once installed, you can use **Reliverse CLI** to create new projects or manage existing ones. Navigate to the root of your desired directory and run:
77
+
See the [Installation](#installation) section for more details.
57
78
58
-
```bash
59
-
reliverse
60
-
```
79
+
## Collaborate
61
80
62
-
> **Temporary issue**: It seems that currently if you build and publish a project using bun , then the project does not run with a global installation, so *now wherever README.md says to use `bun`, please use `pnpm` instead*.
81
+
Reliverse team is open to partnerships and collaborations. If you are interested in working together, please contact us. Discord: <https://discord.gg/Pb8uKbwpsJ>.
63
82
64
83
## FAQ
65
84
66
-
**Bun doesn't install the latest version of Reliverse CLI. What should I do?**
85
+
**Bun doesn't install the latest version of @reliverse/cli. What should I do?**
67
86
68
87
```bash
69
88
bun pm cache rm -g
@@ -72,7 +91,7 @@ bunx reliverse # OR bunx reliverse@latest
72
91
73
92
**Why you don't use monorepo?**
74
93
75
-
Our mission is to make web development accessible and understandable for everyone. By everyone, we also mean any tool. Unfortunately, not every web tool works perfectly with monorepo, including Bun, which is critical for us. Strange things can sometimes happen with a monorepo codebase. But it depends on the vision of the project. If there is a real need for monorepo and all the tools work well, we will be free to switch to it. There has already been an attempt to switch to a monorepo structure, the developments were saved and available as a monorepo bootstrap using Reliverse CLI itself.
94
+
Our mission is to make web development accessible and understandable for everyone. By everyone, we also mean any tool. Unfortunately, not every web tool works perfectly with monorepo, including Bun, which is critical for us. Strange things can sometimes happen with a monorepo codebase. But it depends on the vision of the project. If there is a real need for monorepo and all the tools work well, we will be free to switch to it. There has already been an attempt to switch to a monorepo structure, the developments were saved and available as a monorepo bootstrap using @reliverse/cli itself.
76
95
77
96
## Reliverse Addons
78
97
@@ -87,12 +106,12 @@ Reliverse Addons, also called as extensions or plugins, are projects that extend
87
106
-**Interactive Setup**: Customize your setup with interactive prompts that let you choose specific file categories to include.
88
107
-**Template-Driven Initialization**: Instantly clone and set up templates from GitHub to jumpstart your development.
89
108
-**Versatile Functionality**: Not just for templates! Planning to clone a JS library or experiment with new setups? Reliverse can support it all.
90
-
-**Enhanced shadcn/ui CLI Integration**: [W.I.P] The Reliverse CLI integrates with the shadcn/ui CLI, enabling seamless addition of components and dependencies to your project. With added features and support for shadcn-vue and shadcn-svelte (community-led ports for Vue and Svelte), you can easily add shadcn/ui components to React, Vue, and Svelte projects. Checkboxes let you select and install multiple components at once. Note: Reliverse and these community-supported ports are not affiliated with @shadcn.
109
+
-**Enhanced shadcn/ui CLI Integration**: [W.I.P] The @reliverse/cli integrates with the shadcn/ui CLI, enabling seamless addition of components and dependencies to your project. With added features and support for shadcn-vue and shadcn-svelte (community-led ports for Vue and Svelte), you can easily add shadcn/ui components to React, Vue, and Svelte projects. Checkboxes let you select and install multiple components at once. Note: Reliverse and these community-supported ports are not affiliated with @shadcn.
91
110
-**Future Expansion**: While currently optimized for JavaScript and TypeScript projects (e.g., React, Astro, Vue, Svelte), Reliverse is envisioned to grow beyond web development into a comprehensive toolset you’ll love. This is the founder’s vision for Reliverse—to become the single tool for everything.
92
111
93
112
### Commands
94
113
95
-
The Reliverse CLI offers a series of interactive prompts to streamline your project setup:
114
+
The @reliverse/cli offers a series of interactive prompts to streamline your project setup:
96
115
97
116
1.**Create a New Project**: Start from scratch or use predefined templates for a quick setup.
98
117
2.**Install GitHub Templates**: Easily install any JavaScript or TypeScript project by providing a GitHub repository URL.
@@ -102,7 +121,7 @@ The Reliverse CLI offers a series of interactive prompts to streamline your proj
102
121
103
122
### Example Workflow
104
123
105
-
Here’s an example session of using **Reliverse CLI**:
124
+
Here’s an example session of using **@reliverse/cli**:
106
125
107
126
```bash
108
127
$ reliverse
@@ -135,7 +154,7 @@ When setting up a project, you can choose from the following file categories:
135
154
136
155
## Conflict Management
137
156
138
-
**Reliverse CLI** helps you handle configuration conflicts for existing files such as `.eslintrc.cjs` or `prettier.config.js`. It prompts you with options to:
157
+
**@reliverse/cli** helps you handle configuration conflicts for existing files such as `.eslintrc.cjs` or `prettier.config.js`. It prompts you with options to:
139
158
140
159
-**Remove**: Delete the existing file.
141
160
-**Rename**: Rename the file (e.g., add `.txt` to disable it).
@@ -188,7 +207,7 @@ Visit the [Installation](#installation) section and select **Tools Installation*
188
207
189
208
#### Classical Method
190
209
191
-
To contribute to **Reliverse CLI**, you can clone the repository and install the dependencies:
210
+
To contribute to **@reliverse/cli**, you can clone the repository and install the dependencies:
0 commit comments