Add feature to pass env file path from the CLI
This commit is contained in:
15
README.md
15
README.md
@@ -34,6 +34,7 @@ Options:
|
||||
-p, --port Port to listen on [number]
|
||||
-r, --rate-limit-enabled Enable rate limiting [boolean]
|
||||
-c, --cors CORS whitelist origins [string]
|
||||
--env, --envpath Path to load .env file [string]
|
||||
-a, --auth Enable authentication and authorization [boolean]
|
||||
|
||||
--iuu, --initialuserusername Initial user username [string]
|
||||
@@ -98,6 +99,20 @@ soul -d foobar.db updatesuperuser --id=1 --is_superuser=true // Upgrade the user
|
||||
soul -d foobar.db updatesuperuser --id=1 --is_superuser=false // Revoke the superuser role from the superuser with ID 1
|
||||
```
|
||||
|
||||
### Passing Custom Path for .env File
|
||||
|
||||
There might be cases where you want to pass a custom path for your `.env` file. For this, you can use the `--env` flag when running the `soul` command, providing the absolute file path of your `.env` file.
|
||||
|
||||
```shell
|
||||
soul -d foobar.db --env=/Users/Documents/Projects/React-Project/.env
|
||||
```
|
||||
|
||||
NOTE:
|
||||
|
||||
- You should pass an absolute file path of the .env file.
|
||||
- Relative paths are not allowed.
|
||||
- Don't forget to include the .env file in the specified path.
|
||||
|
||||
## Documentation
|
||||
|
||||
API documentation is available while the project is running at [http://localhost:8000/api/docs](http://localhost:8000/api/docs)
|
||||
|
||||
@@ -46,6 +46,12 @@ if (process.env.NO_CLI !== 'true') {
|
||||
type: 'string',
|
||||
demandOption: false,
|
||||
})
|
||||
.options('env', {
|
||||
alias: 'envpath',
|
||||
describe: 'Environment variable file path to load',
|
||||
type: 'string',
|
||||
demandOption: false,
|
||||
})
|
||||
.options('a', {
|
||||
alias: 'auth',
|
||||
describe: 'Enable authentication and authorization',
|
||||
|
||||
@@ -6,7 +6,7 @@ const { yargs } = require('../cli');
|
||||
|
||||
const { argv } = yargs;
|
||||
|
||||
dotenv.config({ path: path.join(__dirname, '../../.env') });
|
||||
dotenv.config({ path: argv.envpath || path.join(__dirname, '../../.env') });
|
||||
|
||||
const envVarsSchema = Joi.object()
|
||||
.keys({
|
||||
|
||||
Reference in New Issue
Block a user