The anatomy of Vapor commands

The Vapor toolbox

The very very first thing I need to present you (once more) is the Vapor toolbox command line utility. It is a good little handy software for initializing new Vapor purposes from scratch. You should use it to construct, run, replace, check and even deploy (to Heroku) your undertaking.

vapor new myProject
cd myProject
vapor construct
vapor run

Personally I am not utilizing it an excessive amount of, besides once I create a brand new undertaking. I would like to generate extra “boilerplate” code for controllers, fashions utilizing the toolbox, however sadly this function isn’t carried out but. The loopback-cli is a superb instance tho… 🙏

You’ll be able to run vapor --help to see all of the out there instructions.

Serve

Each server must hear for incoming requests on some port. The serve command begins the Vapor utility and fires up the HTTP server. You’ll be able to specify the hostname and the port utilizing some extra flags. The bind flag combines the hostname and port flags into one, they each have brief and lengthy variations, be at liberty to select your favourite command format. 😉

swift run Run


swift run Run serve
swift run Run serve --hostname "localhost" --port 8080
swift run Run serve -h "localhost" -p 8080
swift run Run serve --bind "localhost:8080"
swift run Run serve -b "localhost:8080"

You need to know that that is the default command, so if you happen to merely run your app with none arguments, the serve command will probably be executed behind the scenes. 💀

Migrate

Once you work with databases using Fluent, you want a schema first. You’ll be able to solely populate the database with precise information after the principle construction exists. This course of is named migration. You will additionally should migrate your database if you happen to change one thing in your Fluent code (for instance you introduce a brand new discipline for a mannequin). You’ll be able to carry out a migration by operating:

swift run Run migrate


swift run Run migrate --auto-migrate


swift run Run migrate --revert

The cli will present you what must be carried out with a view to hold your DB up-to-date. You’ll be able to double test every thing yet one more time earlier than you proceed, or you may skip the whole affirmation dialog by utilizing the --auto-migrate possibility. Be extraordinarily cautious with auto migrations! ⚠️

Log ranges

You may need seen that there are a bunch of Vapor messages in your console. Nicely, the excellent news is that you would be able to filter them by log stage. There are two methods of doing this. The primary possibility is to supply a log flag with one of many following values:

• hint
• debug
• information
• discover
• warning
• error
• important

The --log flag has no brief variant, do not attempt to use -l.

If you wish to hint, debug and information logs, you may run the app like this:

swift run Run --log discover

The second possibility is to set a LOG_LEVEL variable earlier than you run the app.

LOG_LEVEL=discover swift run Run


export LOG_LEVEL=discover
swift run Run

unset LOG_LEVEL

The exported variable will probably be round till you shut the terminal window otherwise you take away it.

Setting

Each Vapor utility can run in improvement or manufacturing mode. The default mode is improvement, however you may explicitly set this utilizing the command line:

DB_URL="postgres://myuser:[email protected]:5432/mydb"


swift run Run --env improvement
swift run Run -e dev


DB_URL="postgres://realuser:[email protected]:5432/realdb"


swift run Run --env manufacturing
swift run Run -e prod

It’s potential to retailer environmental variables in a dot env file. The .env.improvement file will probably be loeaded in improvement mode and the .env file in manufacturing mode. You may also use the .env.testing file for the check atmosphere.

You may also override environmental variables with a neighborhood variable, like the way in which we outlined the LOG_LEVEL earlier than. So as an example if in case you have a DB_URL in your manufacturing .env file, however you continue to need to use the dev database, you may run Vapor like this:

DB_URL="postgres://myuser:[email protected]:5432/mydb" swift run Run --env manufacturing

Setting variables are tremendous cool, it is best to mess around with them to get acquainted.

Routes

That is very helpful command to shortly show all of the related endpoints that your app has.

swift run Run routes

When you want extra information about how routing works in Vapor 4, it is best to test the official docs.

Boot

Actually: I’ve by no means used the boot command earlier than, however it’s there. ¯_(ツ)_/¯

swift run Run boot

Can any person inform me a use case for this?

Customized instructions

It’s potential to jot down your customized instructions using the brand new Command API in Vapor 4. In case you are excited by writing Swift scripts, it is best to proceed studying the linked article. 📚

There are many different Swift compiler flags (e.g. -Xswiftc -g to make Backtrace.print() work) that you should utilize throughout the construct course of. In case you are excited by these please let me know and perhaps I will make an article about it within the not so distant future.