Add your first project from the page

Name your first project and point it at the folder it reads. Revetly writes the declaration for you.

Before you start

• Give an instance a provider key and confirm it
• Run an instance with no provider key
• Have the documents this project reads on the machine the engine runs on.

Configuration page

1. Open the configuration page. If it is not open, run revetly config and open the address it prints.

2. Select Add your first project.

   If the page offers to add another project, Troubleshooting below says what to do.

   You should see Name this project.

3. Enter a short name for this project.

4. Select Continue.

   You should see Where it lives.

5. Enter the folder this project is read out of. Leave it empty to keep this project where Revetly was set up.

6. Select Save and continue.

   You should see Point it at your work.

7. Copy your documents into the docs folder inside the project folder. Revetly reads that folder and nothing above it.

8. Leave the sources as they are, then select Save and continue.

   You should see What will this cost?

9. Read the project's card, below the step you are on.

   You should see Documents: docs on the card.

Command line

1. In revetly.toml at the project root, set the group_id under [project]:

   # revetly.toml
   [project]
   group_id = "demo"
   

   Replace demo with the name you want on what this project saves.

2. Read the name back:

   revetly projects
   

   default project: demo
   

Troubleshooting

• No project card appears after the last step. Nothing this project declares holds a file yet. Put one document in its folder and reload the page.
• The page offers Add project rather than Add your first project. A folder this instance declares already holds a document, so its project is drawn as a card. Rename that project on the card with Change.

Next steps

• Price and run the first pass, and know it landed
• Connect a documents folder