# README
Griffon
Installation
To install Griffon
, follow these steps:
-
Make sure you have Go installed on your machine.
-
Open a terminal and run the following command to install
Griffon
:go install github.com/bensooraj/griffon/cmd/[email protected]
-
Once the installation is complete, you can verify it by running:
griffon version
This should display the version number of
Griffon
.
Usage
To use Griffon
, follow these steps:
-
Open a terminal and navigate to your project directory.
-
Run the following command to initialize
Griffon
in your project:griffon init
This will create two files
griffon.hcl
andstartup_script.my_script.sh
in your project directory. -
Create an SSH key pair at
~/.ssh/id_ed25519.pub
by running the following command,ssh-keygen -t ed25519 -C "<your-email-id>"
-
Run the following command to create the
Vultr
resources:export VULTR_API_KEY=<your vultr API key> griffon create -f griffon.hcl
This will execute the
Griffon
command and perform the tasks specified in yourgriffon.yaml
file.
License
Griffon
is licensed under the MIT License