Skip to content

Commit 068d122

Browse files
authored
Merge pull request #3 from OpenPathfinder/feat/version-compatibility
Changes: - New Features - Introduced CLI commands to display version information and perform a health check on the visionBoard API. - Added support for configuring the visionBoard CLI via an environment variable. - Documentation - Updated documentation to explain configuration options and usage examples. - Tests - Added unit tests for CLI commands and utility functions. - Chores - Added new dependencies for HTTP requests, validation, and testing. - Refactor - Improved CLI structure by delegating command logic and output handling to dedicated modules.
2 parents 126df51 + 6670cb9 commit 068d122

File tree

10 files changed

+705
-12
lines changed

10 files changed

+705
-12
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,28 @@ visionboard
5050

5151
This will display the help information with available commands.
5252

53+
## Configuration
54+
55+
The visionBoard CLI supports configuration through environment variables:
56+
57+
### Environment Variables
58+
59+
| Variable | Description | Default |
60+
|----------|-------------|--------|
61+
| `VISIONBOARD_INSTANCE_URL` | URL of the visionBoard API instance | `http://localhost:3000` |
62+
63+
**Note**: The URL must include a protocol (http:// or https://).
64+
65+
Example usage:
66+
67+
```bash
68+
# Set the API URL for a single command
69+
VISIONBOARD_INSTANCE_URL=https://api.visionboard.example.com visionboard
70+
71+
# Or export it for the current session
72+
export VISIONBOARD_INSTANCE_URL=https://api.visionboard.example.com
73+
visionboard
74+
```
5375

5476
## Development
5577

0 commit comments

Comments
 (0)