> For the complete documentation index, see [llms.txt](https://docs.hyperstack.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperstack.org/rails-installation/using-the-installer.md).

# Using the Hyperstack Installer

In the directory of your existing or newly created Rails app:

* add `gem 'rails-hyperstack', "~> 1.0.alpha1.0"` to your `Gemfile`
* run `bundle install`
* run `bundle exec rails hyperstack:install`

> Note: if you want to use the unreleased edge branch your gem specification will be:
>
> ```ruby
> gem 'rails-hyperstack',
>      git: 'git://github.com/hyperstack-org/hyperstack.git',
>      branch: 'edge',
>      glob: 'ruby/*/*.gemspec'
> ```
>
> **HOWEVER currently we are doing weekly alpha updates, you should not need to do this.**

## Start the Rails app

* `bundle exec foreman start` to start Rails and the Hotloader
* Navigate to `http://localhost:5000/`

You will see an empty page with the word "App" displayed.

Open your editor and find the file `/app/hyperstack/components/app.rb`

Change the `'App'` to `'Hello World'` and save the file.

You should see the page on the browser change to "Hello World"

You are in business!

> If this does not work, please contact us on [*slack*](https://hyperstack.org/slack), or [**create an issue on github.**](https://github.com/hyperstack-org/hyperstack/issues/new)

## Installer Options

You can control what gets installed with the following options:

```
bundle exec rails hyperstack:install:webpack          # just add webpack
bundle exec rails hyperstack:install:skip-webpack     # all but webpack
bundle exec rails hyperstack:install:hyper-model      # just add hyper-model
bundle exec rails hyperstack:install:skip-hyper-model # all but hyper-model
bundle exec rails hyperstack:install:hotloader        # just add the hotloader
bundle exec rails hyperstack:install:skip-hotloader   # skip the hotloader
```

> Note that the `:webpack` and `:skip-webpack` options control whether the installer will add the webpacker Gem. If webpacker is already installed in the Gemfile then the installer will always integrate with webpacker.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.hyperstack.org/rails-installation/using-the-installer.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.