https://github.com/fnproject/cli
CLI tool for fnproject.
https://github.com/fnproject/cli
Last synced: about 1 month ago
JSON representation
CLI tool for fnproject.
- Host: GitHub
- URL: https://github.com/fnproject/cli
- Owner: fnproject
- License: apache-2.0
- Created: 2017-07-27T17:01:37.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-04-28T10:18:31.000Z (about 1 year ago)
- Last Synced: 2025-05-09T01:59:07.129Z (about 1 year ago)
- Language: Go
- Homepage: https://fnproject.io
- Size: 17.7 MB
- Stars: 137
- Watchers: 36
- Forks: 68
- Open Issues: 131
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Fn CLI
[](https://circleci.com/gh/fnproject/cli)
## Install
MacOS installation:
```sh
brew update && brew install fn
```
or
Alternatively for Linux/Unix/MacOS:
```sh
curl -LSs https://raw.githubusercontent.com/fnproject/cli/master/install | sh
```
## General Information
* See the Fn [Quickstart](https://github.com/fnproject/fn/blob/master/README.md) for sample commands.
* [Detailed installation instructions](http://fnproject.io/tutorials/install/).
* [Configure your CLI Context](http://fnproject.io/tutorials/install/#ConfigureyourContext).
* For a list of commands see [Fn CLI Command Guide and Reference](https://github.com/fnproject/docs/blob/master/cli/README.md).
* For general information see Fn [docs](https://github.com/fnproject/docs) and [tutorials](https://fnproject.io/tutorials/).
## CLI Development
* Refer to the [Fn CLI Wiki](https://github.com/fnproject/cli/wiki) for development details.
## Watch (local auto-deploy)
To watch a directory and automatically redeploy to a local Fn server when files change:
```sh
fn watch --app
```
This watches the current directory recursively and triggers:
```sh
fn deploy --app --local --no-bump
```
### Ignoring paths
`fn watch` ignores these directories by default:
- `.git`, `.fn`, `node_modules`, `target`, `dist`, `vendor`, `Dockerfile-fn-tmp*`
You can add more ignore rules by creating a `.fnignore` file in the watched directory (one pattern per line; `#` comments supported), and/or by passing `--ignore` flags.
### Build from source
See [CONTRIBUTING](https://github.com/fnproject/cli/blob/master/CONTRIBUTING.md) for instructions to build the CLI from source.