Skip to content
k-scratch allows you to get, edit and immediately send back changes to Azure Functions for fast prototyping. This is a port of k-scratch from .NET Core.
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
build/output
dev
output
src
tests
.gitignore
.npmignore
LICENSE
README.md
gulpfile.js
package.json

README.md

k-scratch

K-Scratch allows you to get, edit and immediately send back changes to Azure Functions for fast prototyping.

It's a great way to edit your functions on Windows, Linux and Mac using open source development tools such as Atom and Visual Studio Code. When you save edits to your files they are immediately sent back to Azure.

You can fire your Functions remotely and see the result in your local console as all debug output is sent from the remote Azure environment right to your local console.

Works great with Visual Studio Code - this GIF shows it working in the Visual Studio Code terminal, automatically uploading after the TypeScript was built. (The example shown here is this repo).

Warning: This is a tool to aid in the development of Azure Functions - you shouldn't edit your production Functions in this way.

Note: This is a command line tool - it's not meant to be used as a "require". If you want to access your Kudu Scm site through a nice node API, then you're looking for kudu-api (which this project uses :)).

npm install -g k-scratch

It's still under dev - please raise issues! I'm active on this at the moment - updating lots, so make sure you check back for updates!

-h, --help                 output usage information
-V, --version              output the version number
-l, --log                  output the Kudulog stream to the console
-p, --path [functionPath]  the base path of your function (blank for current path)
--profile [profilePath]    full path to a profile file (optional - will auto scan up for profile path if omitted)
-m, --monitor              monitor the path for changes and send them up
-g, --get                  download the Function app ready for editing locally, works with the -f sub folder option
-u, --upload               upload a folder to the server, works with the -f sub folder option
-f, --folder [folder]      sub folder to get or upload, if omitted it will get or send everything under wwwroot from Kudu
-s, --scm                  open the Kudu Scm Site in your default browser
-k, --key [key]            function key for use when calling test endpoints
-d, --diagram [path]       create a diagram of the function and save it to the file parameter

Grab a publish profile from Azure. Click on your Functions top level menu item and select "Download publish profile".

Copy the publish profile in to a new empty folder. The publish profile can be in any folder up the path, but it's easiest to pop it in the root of your new editing spot then work in a ./src style path.

somefunc.publishsettings
    src\host.json
    src\somefuc\run.csx
    etc...

You can run ks by changing to the folder where your publish settings are are located (or any child) or you can use the -p option to set a path (absolute or relative).

It's a good idea to keep your publish settings up the path, outside of your repo so you don't accidentally check it in. The -p is the location of the source files you'll be working with, it's not the location of the publish settings file itself.

ks -l -p ~/dev/something

Note: Azure Functions now has a deployment slot capability. Working with a different slot is as easy and navigating to the slot in the Azure Portal and downloading that slots publish settings file.

Logging

Output the log stream to your local console.

ks -l

Monitor Files

Monitor and upload files as soon as you save them. ks -m

This works well with the -l option so you can monitor and see the output.

Note for Windows Linux Bash: If you're using Windows Subsystem for Linux you cannot get file monitoring events in Linux for files you edit in Windows (like editing in VS Code, but running k-scratch in Linux for example). You will have to run k-scratch in CMD or Powershell.

Download Files

Copy your function files to you local path.

ks -g

Note: Be careful not to overwrite your local changes with this command - it will not ask you before overwriting files that exist!

Upload Files

Upload your entire function set of folders to the server.

ks -u

Limit to Sub Folder

You can operate on a sub folder by using ks -u -f somefunc. This works with -g too.

Graphing

You can create a funcgraph graph - ks -d pathToSvgOutput.svg

Note: This graph is generated from your local copy of the Functions. Remember to use -g to get the latest version from the server first. But be careful not to overwrite!

Open Kudu

You can open the Kudu Scm site

ks -s

Compatability

It seems to work around the place... if you have troubles please create an issue!

Remote Testing

k-scratch can run your Functions remotely - so you don't have to go in to the portal every time to execute them.

First, you'll need the master key from the portal.

Click on your function main node, navigate to "Settings" and copy the master key.

You now need to pass this in using the -k [key] option.

ks -l -k <yourKey>

When the -k option with key is passed in, k-scratch will enumerate all your functions and assign them a number.

All you have to do is enter the Function number [enter] and k-scratch will run that Function remotely in Azure - automatically passing in any test data you've entered in the Azure Portal Function testing area.

It's handy to have the log stream (-l) on too!

If you're testing with Blob tiggers, make sure the file really exists (and in the test thing put [container]/path/to/file.txt etc.)

The output from the trigger is shown in your console:

[Remote] -> 200
<what ever http returned output from your function if it's a http trigger>
<other outputs from your function if it uses log.Info (needs the -l logging option)>

Support for compiled functions

It's super easy to work with pre-compiled functions too. This works in VS2017 as well!

  • To set up a web project for usage with Azure Functions, follow along here. I did the HttpTrigger sample.
  • Alternatively you can use the Azure Function Tools in Visual Studio 2017.3 and newer. See this article.
  • "Publish" your project to a folder target (in VS, right click web project, select publish and choose the folder option).
  • Drop your publish profile in the root of the publish folder target (the folder up from where all the files actually went).
  • The first time you do this you will need to upload all the files using the -u option (to upload stuff) with the -p option potining to the publish director (with all the published files in them).
  • Start monitoring using -m and pass in the publish folder (with the published files in them) to the -p option.

Now you're ready to edit in Visual Studio / Code. When you want to send files to your live function, run the following build command from the command prompt or run the publish command in Visual Studio again.

msbuild <your csproj>.csproj /p:DeployOnBuild=true /p:PublishProfile=<your profile>

Azure Function tooling for Visual Studio 2017

Visual Studio 2017.3 adds great support for Azure Functions. k-scratch works really well with this - allowing you to rapidly work with live Functions in Azure.

Create a new function and set up publishing to Azure, then perform the publish.

You can then run ks -l -m from your bin\debug\net461 folder or similar. Every time you build, the changes will be fired to the remote host.

Note: You should use the built in Visual Studio publish to Azure option when even you add or remove a new function. K-scratch sort of gets it right, but I experienced some flakyness.

Compatibility with Git / Scm deployment

When you add Git based deployment to your Function, editing in the portal is blocked. Using k-scratch you can edit your function even when it's locked in this way but downloading and editing locally then sending the files back up via Kudu.

When you check in, Kudu will re-deploy you changes from Git the same as usual.

Note: Again - please don't using k-scratch on production Functions - it's a dev tool only. Sure - write production code with it, but you've been warned about editing in production!

You can’t perform that action at this time.