Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Update README with CLI setup #76

Merged
merged 1 commit into from
Oct 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 44 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,35 +318,66 @@ options.onActivation = { ... }
let f = try createInstance(options: options)
```

### Test runner
### CLI

### Options
To install it locally use below commands. Note, we use featurevisor-swift to avoid conflicts with other Featurevisor CLIs

```bash
'only-failures'
$ cd path/to/featurevisor-swift-sdk
$ swift build -c release
$ cd .build/release
$ cp -f Featurevisor /usr/local/bin/featurevisor-swift
```

If you are interested to see only the test specs that fail:
Now you can usage like below:
```bash
$ cd path/to/featurevisor-project-with-yamls
$ featurevisor-swift test .
```

Example command:
To install via Swift Package Manager, you need to add it as a dependency under your `Package.swift` file , where `X.X.X` is the version which you want to use.

```swift
dependencies: [
.package(
url: "https://github.com/featurevisor/featurevisor-swift",
exact: "X.X.X"
)
]
```

To run use below command:

```bash
$ swift run featurevisor test .
```

You can also install it locally using below commands. Note, we use featurevisor-swift to avoid conflicts with other Featurevisor CLIs
To update the swift's featurevisor use below command:

```bash
$ swift package update
```
$ cd path/to/featurevisor-swift-sdk
$ swift build -c release
$ cd .build/release
$ cp -f Featurevisor /usr/local/bin/featurevisor-swift

### Tests
If you would like to test your feature/s setup against Swift SDK you can do this by invoking the below command.
Currently, it takes all features which are being supported by `ios` and `tvos` and run tests for them.

```bash
$ swift run featurevisor test .
```

Now you can usage like below:
#### Options

```bash
'only-failures'
```
$ cd path/to/featurevisor-project-with-yamls
$ featurevisor-swift test .

If you are interested to see only the test specs that fail:

Example command:

```
$ swift run featurevisor test --only-failures .
```

### Benchmarking
Expand Down
Loading