mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
Restructure and add quickstart to docs
This commit is contained in:
20
docs/cli/reference/commands.mdx
Normal file
20
docs/cli/reference/commands.mdx
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: "Commands"
|
||||
---
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Description |
|
||||
| ------- | -------------------------------------------------------------------- |
|
||||
| `login` | Used to authenticate and set the logged in user. |
|
||||
| `init` | Used to link a local project to the platform. |
|
||||
| `run` | Used to inject envars from the platform into an application process. |
|
||||
|
||||
## Global options
|
||||
|
||||
| Option | Description |
|
||||
| ----------------- | ----------------------------------------------- |
|
||||
| `--help`, `-h` | List help for any command |
|
||||
| `--debug`, `-d` | Enable verbose logging |
|
||||
| `--domain` | Use to direct Infisical to a self-hosted domain |
|
||||
| `--version`, `-v` | Print version information and quit |
|
||||
13
docs/cli/reference/init.mdx
Normal file
13
docs/cli/reference/init.mdx
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: "infisical init"
|
||||
---
|
||||
|
||||
```bash
|
||||
infisical init
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
Link a local project to the platform
|
||||
|
||||
The command creates a `infisical.json` file containing your Project ID.
|
||||
13
docs/cli/reference/login.mdx
Normal file
13
docs/cli/reference/login.mdx
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: "infisical login"
|
||||
---
|
||||
|
||||
```bash
|
||||
infisical login
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
Verify a user and save credentials to the system keyring.
|
||||
|
||||
To change the logged in user, run the command again to overwrite the previous login.
|
||||
18
docs/cli/reference/run.mdx
Normal file
18
docs/cli/reference/run.mdx
Normal file
@@ -0,0 +1,18 @@
|
||||
---
|
||||
title: "infisical run"
|
||||
---
|
||||
|
||||
```bash
|
||||
infisical run [options] -- [your application start command]
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
Inject environment variables from the platform into an application process.
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Description | Default value |
|
||||
| ------------- | ----------------------------------------------------------------------------------------------------------- | ------------- |
|
||||
| `--env` | Used to set the environment that secrets are pulled from. Accepted values: `dev`, `staging`, `test`, `prod` | `dev` |
|
||||
| `--projectId` | Used to link a local project to the platform (required only if injecting via the service token method) | `None` |
|
||||
Reference in New Issue
Block a user