Website fix sia (#1345)

* Adjust SIA commands accordingly

* Remove old pages

Co-authored-by: jmaslek <jmaslek11@gmail.com>
This commit is contained in:
Jeroen Bouma
2022-02-10 15:39:35 +01:00
committed by GitHub
parent 1ab915f1bc
commit cf37111b7f
6 changed files with 114 additions and 130 deletions

View File

@@ -5,42 +5,41 @@ geekdocCollapseSection: true
{{< toc-tree >}}
```text
┌─────────────────────────────────────── Stocks - Sector and Industry Analysis ───────────────────────────────────────┐
│ │
│ load load a specific ticker and all it's corresponding parameters │
│ │
│ clear clear all or one of industry, sector, country and market cap parameters │
│ industry see existing industries, or set industry if arg specified │
│ sector see existing sectors, or set sector if arg specified │
│ country see existing countries, or set country if arg specified │
│ mktcap set mktcap between small, mid or large │
│ exchange revert exclude international exchanges flag │
│ │
│ Industry : Financial Data & Stock Exchanges │
│ Sector : Financial Services │
│ Country : United States │
│ Market Cap : Large │
│ Exclude Exchanges : True │
│ Period : Annual │
│ │
│ Statistics │
│ cps companies per Sector based on Country and Market Cap │
│ cpic companies per Industry based on Country and Market Cap │
│ cpis companies per Industry based on Sector and Market Cap │
│ cpcs companies per Country based on Sector and Market Cap │
│ cpci companies per Country based on Industry and Market Cap │
│ │
│ Financials [Yahoo Finance] │
│ sama see all metrics available │
│ metric visualise financial metric across filters selected │
│ Financials [StockAnalyis] │
│ bs see all balance sheet items available │
│ cf see all cash flow statement items available │
│ is see all income statement items available │
│ visualise visualise financial metric across filters selected │
│ │
│ Returned tickers: │
│ > ca take these to comparison analysis menu │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────── Gamestonk Terminal ─┘
┌───────────────────────────────────────────────────────────────────────────────────────────────── Stocks - Sector and Industry Analysis ──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ │
│ load load a specific ticker and all it's corresponding parameters │
│ │
│ clear clear all or one of industry, sector, country and market cap parameters │
│ industry see existing industries, or set industry if arg specified │
│ sector see existing sectors, or set sector if arg specified │
│ country see existing countries, or set country if arg specified │
│ mktcap set mktcap between nano, micro, small, mid, large or mega │
│ exchange revert exclude international exchanges flag │
│ period set period between annual, quarterly or trailing [StockAnalyis] │
│ │
│ Industry : Auto Manufacturers │
│ Sector : Consumer Cyclical │
│ Country : United States │
│ Market Cap : Large │
│ Exclude Exchanges : True │
│ Period : Annual │
│ │
│ Statistics │
│ cps companies per Sector based on Country and Market Cap │
│ cpic companies per Industry based on Country and Market Cap │
│ cpis companies per Industry based on Sector and Market Cap │
│ cpcs companies per Country based on Sector and Market Cap │
│ cpci companies per Country based on Industry and Market Cap │
│ │
│ Financials [Yahoo Finance] │
│ sama see all metrics available │
│ metric visualise financial metric across filters selected │
│ Financials [StockAnalyis] │
│ satma see all metrics available over time │
│ vis visualise financial metric across filters selected │
│ │
│ Returned tickers: │
│ > ca take these to comparison analysis menu │
│ │
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Gamestonk Terminal ─┘
```

View File

@@ -1,38 +0,0 @@
```text
usage: bs [-h]
```
See all balance sheet statement metrics available [source: StockAnalysis]
```
optional arguments:
-h, --help show this help message (default: False)
```
The current list of available options is:
ce cash & equivalents
sti short-term investments
cce cash & cash equivalents (ce + sti)
rec receivables
inv inventory
oca other current assets
tca total current assets (rec + inv + oca)
ppe property, plant & equipment
lti long-term investments
gai goodwill and intangibles
olta other long-term assets
tlta total long-term assets (lti + gai + olta)
ta total assets (tca + tlta)
ap accounts payable
dr deferred revenue
cd current debt
ocl other current liabilities
tcl total current liabilities (ac + dr + cd + ocl + tcl)
ltd long-term debt
oltl other long-term liabilities
tltl total long-term liabilities (ltd + oltl)
tl total liabilities (tltl + tcl)
ret retained earnings
ci comprehensive income
se stakeholders' equity
tle total liabilities and equity (tl + re + ci + se)

View File

@@ -1,28 +0,0 @@
```text
usage: cf [-h]
```
See all cash flow statement metrics available [source: StockAnalysis]
```
optional arguments:
-h, --help show this help message (default: False)
```
The current list of available options is:
ninc net income
da depreciation & amortization
sbc share-based compensation
ooa other operating activities
ocf operating cashflow (ni + da + sbc + ooa)
cex cash expenditures
acq acquisitions
cii change in investments
oia other investing activities
icf investing cashflow (cex + acq + cii + oia)
dp dividends paid
si share issuance / repurchase
di debt issued / paid
ofa other financing activities
fcf financing cashflow (dp + si + di + ofa)
ncf net cashflow (ocf + icf + fcf)

View File

@@ -1,24 +0,0 @@
```text
usage: is [-h]
```
See all income statement metrics available [source: StockAnalysis]
```
optional arguments:
-h, --help show this help message (default: False)
```
The current list of available options is:
re revenue
cr cost of revenue
gp gross profit (re - cr)
sga selling, general and administrative
rd research & development
ooe other operating expenses
oi operating income (gp - sga - rd - ooe)
ie interest expense / income
oe other expenses / income
it income tax
ni net income (oi - ie - oe - it)
pd preferred dividends

View File

@@ -0,0 +1,74 @@
```text
usage: satma [-s {BS,bs,IS,is,CF,cf,}] [-h]
```
See all balance sheet, income and cash flow statement metrics available [source: StockAnalysis]
```
optional arguments:
-s {BS,bs,IS,is,CF,cf,}, --statement {BS,bs,IS,is,CF,cf,}
See all metrics available for the given choice (default: None)
-h, --help show this help message (default: False)
```
The current list of available options is:
````
Balance Sheet Statement
ce Cash & Equivalents
sti Short-Term Investments
cce Cash & Cash Equivalents
rec Receivables
inv Inventory
oca Other Current Assets
tca Total Current Assets
ppe Property, Plant & Equipment
lti Long-Term Investments
gai Goodwill and Intangibles
olta Other Long-Term Assets
tlta Total Long-Term Assets
ta Total Assets
ap Accounts Payable
dr Deferred Revenue
cd Current Debt
ocl Other Current Liabilities
tcl Total Current Liabilities
ltd Long-Term Debt
oltl Other Long-Term Liabilities
tltl Total Long-Term Liabilities
tl Total Liabilities
ret Retained Earnings
ci Comprehensive Income
se Shareholders' Equity
tle Total Liabilities and Equity
Income Statement
re Revenue
cr Cost of Revenue
gp Gross Profit
sga Selling, Genera & Admin
rd Research & Development
ooe Other Operating Expenses
oi Operating Income
ie Interest Expense / Income
oe Other Expense / Income
it Income Tax
ni Net Income
pd Preferred Dividends
Cash Flow Statement
ninc Net Income
da Depreciation & Amortization
sbc Share-Based Compensation
ooa Other Operating Activities
ocf Operating Cash Flow
cex Capital Expenditures
acq Acquisitions
cii Change in Investments
oia Other Investing Activities
icf Investing Cash Flow
dp Dividends Paid
si Share Insurance / Repurchase
di Debt Issued / Paid
ofa Other Financing Activities
fcf Financing Cash Flow
ncf Net Cash Flow
````

View File

@@ -1,12 +1,13 @@
```text
usage: visualise [-m {ce,sti,cce,rec,inv,oca,tca,ppe,lti,gai,olta,tlta,ta,ap,dr,cd,ocl,tcl,ltd,oltl,tltl,tl,ret,ci,se,tle,re,cr,gp,sga,rd,ooe,oi,ie,oe,it,ni,pd,ninc,da,sbc,ooa,ocf,cex,acq,cii,oia,icf,dp,si,di,ofa,fcf,ncf}] [-l LIMIT] [-p PERIOD] [-r] [-h] [--export {csv,json,xlsx,png,jpg,pdf,svg}]```
usage: vis [-m {ce,sti,cce,rec,inv,oca,tca,ppe,lti,gai,olta,tlta,ta,ap,dr,cd,ocl,tcl,ltd,oltl,tltl,tl,ret,ci,se,tle,ninc,da,sbc,ooa,ocf,cex,acq,cii,oia,icf,dp,si,di,ofa,fcf,ncf,re,cr,gp,sga,rd,ooe,oi,ie,oe,it,ni,pd}] [-l LIMIT]
[-p PERIOD] [-r] [-h] [--export {csv,json,xlsx,png,jpg,pdf,svg}]
```
Visualize a particular metric with the filters selected [source: StockAnalysis]
```
optional arguments:
-m {ce,sti,cce,rec,inv,oca,tca,ppe,lti,gai,olta,tlta,ta,ap,dr,cd,ocl,tcl,ltd,oltl,tltl,tl,ret,ci,se,tle,re,cr,gp,sga,rd,ooe,oi,ie,oe,it,ni,pd,ninc,da,sbc,ooa,ocf,cex,acq,cii,oia,icf,dp,si,di,ofa,fcf,ncf}, --metric {ce,sti,cce,rec,inv,oca,tca,ppe,lti,gai,olta,tlta,ta,ap,dr,cd,ocl,tcl,ltd,oltl,tltl,tl,ret,ci,se,tle,re,cr,gp,sga,rd,ooe,oi,ie,oe,it,ni,pd,ninc,da,sbc,ooa,ocf,cex,acq,cii,oia,icf,dp,si,di,ofa,fcf,ncf}
-m {ce,sti,cce,rec,inv,oca,tca,ppe,lti,gai,olta,tlta,ta,ap,dr,cd,ocl,tcl,ltd,oltl,tltl,tl,ret,ci,se,tle,ninc,da,sbc,ooa,ocf,cex,acq,cii,oia,icf,dp,si,di,ofa,fcf,ncf,re,cr,gp,sga,rd,ooe,oi,ie,oe,it,ni,pd}, --metric {ce,sti,cce,rec,inv,oca,tca,ppe,lti,gai,olta,tlta,ta,ap,dr,cd,ocl,tcl,ltd,oltl,tltl,tl,ret,ci,se,tle,ninc,da,sbc,ooa,ocf,cex,acq,cii,oia,icf,dp,si,di,ofa,fcf,ncf,re,cr,gp,sga,rd,ooe,oi,ie,oe,it,ni,pd}
Metric to visualize (default: None)
-l LIMIT, --limit LIMIT
Limit number of companies to display (default: 10)