Kyso
Kyso.ioAbout Us
Search…
Getting started with Kyso
Getting started
Installation Options
Organizations & Teams
Publishing & Sharing
Kyso Command Line Tool
Installation
Configuration
Authorization
Publishing & Downloading
Syncing Git Repositories
Publishing HTML & Websites
Creating Reports In-App
Reporting FAQ
Search and Discovery
Configuring Report Metadata
Full-Text Search
COLLABORATION
General Discussion
Report Collaboration
Settings & Administration
Permissions System
Managing Access
Resources
R Users & R Markdown
Migrating from Knowledge Repo
Writing a good data-science report
Introduction to Git
Installing Jupyter with Anaconda
Python Projects Workflow
Using SQL in Jupyterlab
Reproducibility with Docker
Powered By GitBook
Publishing & Downloading
How to push & pull your research to and from Kyso using the Kyso CLI
Kyso CLI pushes contents to Kyso using a special file named kyso.yaml or kyso.json. Content in Kyso is structured across:
  1. 1.
    Organizations
  2. 2.
    Teams
Teams reside with Organizations. An organization can have multiple teams, and every team an unlimited number of reports and discussions.
Kyso currently renders the following document-types (this list will continue to grow):
  • Python based Jupyter Notebooks
  • Python based Jupyter Books (HTML)
  • R Notebooks
  • HTML Files (e.g. MultiQC Reports)
  • Markdown

Publishing Reports

Let us illustrate how to push content to Kyso using an example. In this example we have a Jupyter Notebook report, which is in a folder named jupyter-genomics with the following structure:
1
acme-metrics/
2
├─ docs/
3
├─ images/
4
├─ notebooks/
5
│ ├─ product/
6
│ │ ├─ main.ipynb
Copied!
To be able to push content, we must create a kyso.yaml file in the root folder, in this case, in the jupyter-genomics folder.
Refer to our documentation on Report Metadata to learn more:
Below is an example of a kyso.yaml file:
1
main: notebooks/product/main.ipynb
2
title: "Plotting Account Activity Levels"
3
description: "Measuring the relationship between team size and various engagement metrics like viewspostsand other actions. Should we be focusing more time on smaller accounts or only on the big fish?"
4
preview: images/preview.png
5
organization: acme
6
team: general
7
type: jupyter
8
tags: [genomics, plotly, bioinformatics]
Copied!
So, in this example, a report named "Plotting Account Activity Levels" will be created within the organization "acme" in the team "general".
Once the kyso.yaml file is ready, you can run the following command to push the content:
1
acme-metrics % kyso-cli push --path .
2
Uploading report '.'
3
Report has 14 files
4
Successfully uploaded report!!
Copied!
Now we can check that the report is successfully uploaded to Kyso:
Published report using the Kyso CLI

Downloading Reports

Conversely, we can also download content from Kyso to our data science workspace from the terminal. Here we have two options:
  1. 1.
    A kyso.yaml/json is in our current directory such that, when we run kyso-cli pullKyso will read the metadata to know which report to download.
  2. 2.
    You wish to update an report existing on Kyso. You can run the kyso-cli pull command and explicitly state the project report you're looking for:
1
kyso-cli pull --organization acme --team general --report the-report-kyso-url --path .
2
​
3
Downloading the report...
4
Successfully downloaded the report!!
Copied!
Once you've made your changes, you can push the report back up to Kyso, which will render your latest version by default.
Previous
Authorization
Next - Publishing & Sharing
Syncing Git Repositories
Last modified 9d ago
Copy link
Contents
Publishing Reports
Downloading Reports